UserParameter Object

Derived from: Parameter Object

Description

Object that represents a parameter that was created by the user.

Methods

Name	Description
ConvertToModelParameter	Method that causes the parameter to be converted to a model parameter. The new ModelParameter object is returned.
ConvertToReferenceParameter	Method that causes the parameter to be converted to a reference parameter. The new ReferenceParameter object is returned.
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
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
DisplayFormat
DrivenBy	Method that returns the collection objects that the parameter is dependent on.
ExposedAsProperty
Expression
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
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
Name
ParameterType	Property that allows you to get the type of the parameter. The parameter type can be either kModelParameterType, kReferenceParameterType, kTableParameterType, or kUserParameterType.
Parent	Property that returns the parent Document of this parameter.
Precision
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

Accessed From

ModelParameter.ConvertToUserParameter, ReferenceParameter.ConvertToUserParameter, TableParameter.ConvertToUserParameter, UserParameters.AddByExpression, UserParameters.AddByValue, UserParameters.Item

Samples

Name	Description
Creating a new parameter group	This sample demonstrates the creation of model, reference and user parameters and copying these parameters to a newly created group.

Version

Introduced in version 4