Parameter Object

Description

General parameter type that serves as the base class for all types of parameters. This object is returned when accessing parameters using the Item method of the Parameters collection object.

Methods

Name	Description
Delete	Method that deletes this Parameter.
GetReferenceKey	Method that generates and returns the reference key for this entity.

Properties

Name	Description
AttributeSets	Property that returns the AttributeSets collection object associated with this object.
Comment	Gets the user comments against this parameter.
CustomPropertyFormat	Property that returns the CustomPropertyFormat object associated with this parameter. The CustomPropertyFormat provides control over how the parameter value is formatted when it is exposed as a custom iProperty.
Dependents	Property that returns the collection of objects that have a direct dependency on the parameter.
DisabledActionTypes	Gets and sets the action types valid for this parameter.
DisplayFormat	Gets and sets the display format for the parameter.
DrivenBy	Method that returns the collection objects that the parameter is dependent on.
ExposedAsProperty	Gets/(Sets) the Boolean indicating if this parameter is exposed as a property of this Document.
Expression	Gets/(Sets) the string that denotes the algebraic expression making up the definition of this parameter. Maybe a constant. 'Set' may not be allowed on some parameter types. When set this for Text parameter, the expression value should be quoted by quotation marks at beginning and ending of a string(like """I am Jack""").
ExpressionList	Property that returns the expression list associated with this parameter.
HealthStatus	Property that returns an enum indicating the current state of the object.
InUse	Property that returns whether whether this parameter is currently in use (by a dimension, feature or by any other parameter).
IsKey	Gets and sets whether this parameter is a key parameter or not. Key parameters are typically those that need to be easily accessed and are designated as key to be filtered out from the rest of the parameters.
ModelValue	Property that returns the evaluation of this parameter (in database units) that is currently used by the model. This takes into account the value computed from the expression and the tolerance. This method is only valid for numeric unit types and will fail for Text and Boolean unit types.
ModelValueType	Gets/(Sets) the setting which is used for determining the method used to compute the model value.
Name	Gets/Sets the name of this parameter.
ParameterType	Property that allows you to get the type of the parameter. The parameter type can be either kModelParameterType, kDerivedParameter, kFinishParameter, kReferenceParameterType, kTableParameterType, or kUserParameterType.
Parent	Property that returns the parent Document of this parameter.
Precision	Gets/(Sets) the the number of decimal places displayed for this parameter. Note that the precision is used when applying a standard tolerance to the parameter.
Tolerance	Property that returns the tolerance for this parameter. This property returns Nothing in the case where the unit type of this parameter is kTextUnits or kBooleanUnits.
Type	Returns an ObjectTypeEnum indicating this object's type.
Units	Gets/(Sets) the units of the parameter. Note that the units is always retrieved as a string, but may be set using a constant from UnitsTypeEnum. 'Set' may not be allowed on some parameter types.
Value	Gets/(Sets) the value of this parameter. Numeric values are in database units. Setting this is equivalent to setting the 'Expression' with a constant string. 'Set' may not be allowed on some parameter types.

Accessed From

Derived Classes

DerivedParameter, FinishParameter, ModelParameter, ReferenceParameter, TableParameter, UserParameter

Samples

Name	Description
Sheet Metal Thickness Editing	This sample illustrates editing the thickness of a sheet metal part.

Version

Introduced in version 4