UserParameter Object

Derived from: Parameter Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Fusion/UserParameter.h>

Description

Represents a User Parameter.

Methods

Name Description
classType

Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

deleteMe

Deletes the user parameter A parameter can only be deleted if it is a UserParameter and it is not referenced by other parameters.

Properties

Name Description
attributes Returns the collection of attributes associated with this face.
comment The comment associated with this parameter
dependencyParameters Returns a list of parameters that this parameter is dependent on.
dependentParameters Returns a list of parameters that are dependent on this parameter as a result of this parameter being referenced in their equation.
design Returns the Design containing the UserParameter.
entityToken
expression Gets and sets the expression (ie. "22.064 mm") used to calculate the value of the parameter
isDeletable Gets if this parameter can be deleted. Parameters that cannot be deleted are: Model Parameters and User Parameters that have dependents.
isFavorite Gets and sets whether this parameter is included in the Favorites list in the parameters dialog
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
name Gets and sets the name of the parameter. Setting the name can fail if the name is not unique with respect to all other parameters in the design.
objectType Returns a string indicating the type of the object.
textValue Gets and sets the value of the parameter when it is a text parameter. This can be determined by checking the valueType property. Setting this value will cause the current expression to be overwritten. If the parameter is not a text parameter, the value of this property should be ignored and setting will fail.
unit The unit type associated with this parameter. An empty string is returned for parameters that don't have a unit type.
userParameters Returns the Collection containing the UserParameter.
value Gets and sets the real value (a double) of the parameter in database units. Setting this property will set/reset the expression value for this parameter
valueType Returns the type of value this parameter is. For a numeric parameter, you can get the value using the value property. For a text parameter, you can get the value using the textValue property.

Accessed From

UserParameters.add, UserParameters.asArray, UserParameters.item, UserParameters.itemByName

Version

Introduced in version August 2014