UserParameter.expression Property

Description

Gets and sets the expression used to calculate the value of the parameter. This is the equivalent of the "Expression" column in the Parameters dialog. Numeric parameters can be defined by a simple expression like "6.25", which will be interpreted based on whatever the default units are for the document. For example, if the units are set to millimeters, the value will be 6.25 mm; if the units are inches, it will be 6.25 inches. The expression can also contain the units so "6.25 in" will always be evaluated as inches regardless of the document units.

An expression can also contain references to other parameters and use equations. For example, the expression "Length / 2" is valid for a numeric parameter as long as there is a numeric parameter named "Length".

Syntax

# Get the value of the property.
propertyValue = userParameter_var.expression

# Set the value of the property.
userParameter_var.expression = propertyValue

#include <Fusion/Fusion/UserParameter.h>

// Get the value of the property.
string propertyValue = userParameter_var->expression();

// Set the value of the property, where value_var is a string.
bool returnValue = userParameter_var->expression(value_var);

Property Value

Version