| attributes |
Returns the collection of attributes associated with this face. |
| comment |
The comment associated with this parameter |
| component |
Returns the Component containing the ModelParameter. |
| createdBy |
Returns the object that created this parameter. For example, a feature, a sketch dimension, or a construction plane. |
| 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. |
| entityToken |
Returns a token for the Parameter object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same parameter.
When using entity tokens it's important to understand that the token string returned for a specific entity can be different over time. However, even if you have two different token strings that were obtained from the same entity, when you use findEntityByToken they will both return the same entity. Because of that you should never compare entity tokens as way to determine what the token represents. Instead, you need to use the findEntityByToken method to get the two entities identified by the tokens and then compare them. |
| expression |
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". Expressions can also be used for text parameters, such as concatenating two other text parameters. For example, if there are two existing text parameters named text1 and text2, the expression for another text parameter can be "text1 + text2". More complex equations can also be used with text parameters like "if (Length < 20 mm; 'Short'; 'Long')" where "Length" is a numeric parameter. The resulting string can be obtained using the textValue property. |
| isDeletable |
Gets if this parameter can be deleted. Parameters that have dependents cannot be deleted, and model parameters typically cannot be deleted. However, there is the possibility in uncommon workflows where a model parameter no longer has any dependents, and it was not automatically deleted. In this case, this property will return true, and the deleteMe method can delete the parameter. |
| 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. |
| modelParameters |
Returns the Collection containing the ModelParameter. |
| 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 |
This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.
It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType(): |
| role |
This property identifies what the parameter is used for. For an extrude, it could be "Depth", for a work plane it could be "Offset". |
| 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. |
| 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.
This property is only valid for numeric parameters and will fail for text parameters. You can determine the value type of the parameter by using the valueType property. Use the textValue property to get and set the value of text parameters. |
| 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. |