Sign in
2022 Members
Changes 6
M

Parameter

Name Return Type Description Inherited From
M AsDouble() double Provides access to the double precision number within the parameter.
M AsElementId() ElementId Provides access to the Autodesk::Revit::DB::ElementId^ stored within the parameter.
M AsInteger() int Provides access to the integer number within the parameter.
M AssociateWithGlobalParameter(ElementId) None Associates this parameter with a global parameter in the same document.
M AsString() string Provides access to the string contents of the parameter.
M AsValueString.() string Get the parameter value as a string with units.
M AsValueString(FormatOptions) string Get the parameter value as a string with units.
M CanBeAssociatedWithGlobalParameter(ElementId) bool Tests whether this parameter can be associated with the given global parameter.
M CanBeAssociatedWithGlobalParameters() bool Tests whether this parameter can be associated with any global parameter.
M ClearValue() bool Clears the parameter to its initial value.
M Dispose() None Causes the object to release immediately any resources it may be utilizing. (Inherited from APIObject .) APIObject
M DissociateFromGlobalParameter() None Dissociates this parameter from a global parameter.
M Equals None Determines whether the specified Object is equal to the current Object . (Inherited from Object .) Object .
M GetAssociatedGlobalParameter() ElementId Returns a global parameter, if any, currently associated with this parameter.
M GetHashCode None Serves as a hash function for a particular type. (Inherited from Object .) Object .
M GetType None Gets the Type of the current instance. (Inherited from Object .) Object .
M GetTypeId() ForgeTypeId Gets the identifier of the parameter.
M GetUnitTypeId() ForgeTypeId Gets the identifier of the unit quantifying the parameter value.
M Set(Double) bool Sets the parameter to a new real number value.
M Set(Int32) bool Sets the parameter to a new integer value.
M Set(String) bool Sets the parameter to a new string of text.
M Set(ElementId) bool Sets the parameter to a new element id.
M SetValueString(String) bool Set the parameter value according to the input string.
M ToString None Returns a string that represents the current object. (Inherited from Object .) Object .
Name Return Type Description Inherited From
P Definition Definition Returns the Definition object that describes the data type, name and other details of the parameter.
P Element Element The element to which this parameter belongs.
P GUID Guid The Guid for a shared parameter.
P HasValue bool Identifies if the parameter has an assigned value.
P Id ElementId The id of the parameter.
P IsReadOnly bool Get the readonly property of the parameter. (Overrides APIObject . IsReadOnly .)
P IsShared bool Identifies if the parameter is a shared parameter.
P StorageType StorageType Describes the type that is used internally within the parameter to store its value.
P UserModifiable bool Indicates whether the interactive user can modify the value of this parameter.