PowerShell Commands for Everyday Usage

Variables

Operators

Arithmetic Operators

Arithmetic operators are used in mathematical expressions in the same way that they are used in algebra. The following table lists the arithmetic operators. Additionally, the + and * operators can also be used to work with strings. When you use the * operator, it repeats a string. When you use the + operator, it concatenates strings. 

Assume integer variable A holds 40 and variable B holds 10, then...

Comparison Operators

The following are the assignment operators supported by PowerShell.

Assume integer variable A holds 40 and variable B holds 10, then...

Assignment Operators

The following are the assignment operators supported by PowerShell.

Logical Operators

The following table lists the logical operators.

Assume the boolean variable A is true and variable B is false, then...

Common Revit Functions

The table below lists sample scripts that when modified may help solve typical issues that users face when implementing PowerShell scripts.

Resolutions to common issues

Issue - I'd like to change the formatting of the displayed values.

Values in the Revit database are stored in imperial decimal feet; Revit then converts the stored values to the format set in Project Units. From the eVolve Data Profiles feature, when the Use Display Value checkbox is selected, the stored imperial value is converted to the elected unit set for the project. The issue arises when running a PowerShell script and the return value differs from the base parameter's type, i.e., if the base parameter type is text but the desired formatting for the return value is length, the formatting will only reflect that of a text parameter. The solution is to select a base parameter of the same format type you would like the return value displayed.

Issue - I'd like to display a window with information when a script runs.

After adding the script below, a window is displayed when the PowerShell script runs. You can change the displayed text in the window by modifying the value within quotes and change the parameter value to whatever parameter value you desire.

Solution

[System.Windows.Forms.MessageBox]::Show("Value=" + $value)

Example

[System.Windows.Forms.MessageBox]::Show("This is the Level" + $eVolveElement.LookupParameter("Level").AsValueString())

Issue - Always display parameters

Even though I have the Hide Empty Values option enabled, I would like to always display a parameter even if the value is null or empty.

Solution 1

# Check to see if the parameter exists and the value is null or empty
if (-not $eVolveFromParameter)
{
	# Assigns a value if null or empty
        return "Not Assigned"
}
# If the parameter exists and the value is not null or empty this defines the parameter to use
return $eVolveFromParameter

Solution 2

# Check to see if the parameter exists and the value is null or empty
if (-not $eVolveFromParameter)
{
	# If the value is null or empty, "^abort^" is used to hide the parameter in the panel
	return "^abort^"
}
# If the parameter exists and the value is not null or empty this defines the parameter to use
return $eVolveFromParameter

Issue - Conditionally show parameters

I would like to conditionally show a parameter. For instance, I only want to display a parameter if the value is greater than 25.

Solution

# Check to see if the parameter value is greater than 25.0
if ($eVolveFromParameter -gt 25.0)
{
	# If the value is null or empty, "^abort^" is used to hide the parameter in the panel
	return "^abort^"
}
# If the parameter exists and the value is not null or empty this defines the parameter to use
return $eVolveFromParameter

Issue - Cycle through parameters to populate a single field

I would like to check if a parameter exists and if not use another parameter to populate the field. For example, I want to display the Reference Level in my panel, but when I select one element, the parameter name is "Reference Level" and when I select a different element it is "Level".

Solution 1

# Check to see if the parameter exists and the value is null or empty
if (-not $eVolveFromParameter)
{
	# If the parameter is nul or empty, the parameter below is used
        return $eVolveElement.LookupParameter("Level").AsValueString()
}
else
{
	# If the parameter exists and the value is not null or empty this defines the parameter to use
        return $eVolveFromParameter
}

Solution 2

# Defines the parameter to compare 
$result = $eVolveFromParameter

# Check to see if the parameter exists and the value is null or empty
if (-not $result)
{
	# If the parameter is nul or empty, the parameter below is used
        $result = $eVolveElement.LookupParameter("Level").AsValueString()
}
# Check to see if the parameter exists and the value is null or empty
if (-not $result)
{
	# If the parameter is nul or empty, the parameter below is used
        $result = $eVolveElement.LookupParameter("eV_PackageLevel").AsString()
}
# If the parameter exists and the value is not null or empty this defines the parameter to use
return $result

Issue - Round Numbers

The following solution allows the value to retain its number attribute without having to convert it to a string. Solution 1, return a whole number. Solution 2, returns a decimal value by simply adding a comma and specifying the number of decimal places to return.

Solution 1

${name}= $eVolveElement.LookupParameter("{ParamName}").AsDouble()
return [math]::Round(${name})

If the original value were 12.87567894231564, the returned value would be 12

Solution 2

${name}= $eVolveElement.LookupParameter("{ParamName}").AsDouble()
return [math]::Round(${name},3)

If the original value were 12.87567894231564, the returned value would be 12.875