Parameter Members

The Parameter type exposes the following members.

Methods

  NameDescription
Public methodAsDouble
Provides access to the double precision number within the parameter.
Public methodAsElementId
Provides access to the Autodesk::Revit::DB::ElementId^ stored within the parameter.
Public methodAsInteger
Provides access to the integer number within the parameter.
Public methodAssociateWithGlobalParameter
Associates this parameter with a global parameter in the same document.
Public methodAsString
Provides access to the string contents of the parameter.
Public methodAsValueString()()()()
Get the parameter value as a string with units.
Public methodAsValueString(FormatOptions)
Get the parameter value as a string with units.
Public methodCanBeAssociatedWithGlobalParameter
Tests whether this parameter can be associated with the given global parameter.
Public methodCanBeAssociatedWithGlobalParameters
Tests whether this parameter can be associated with any global parameter.
Public methodClearValue
Clears the parameter to its initial value.
Public methodDispose
Causes the object to release immediately any resources it may be utilizing.
(Inherited from APIObject.)
Public methodDissociateFromGlobalParameter
Dissociates this parameter from a global parameter.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAssociatedGlobalParameter
Returns a global parameter, if any, currently associated with this parameter.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeId
Gets the identifier of the parameter.
Public methodGetUnitTypeId
Gets the identifier of the unit quantifying the parameter value.
Public methodSet(Double)
Sets the parameter to a new real number value.
Public methodSet(Int32)
Sets the parameter to a new integer value.
Public methodSet(String)
Sets the parameter to a new string of text.
Public methodSet(ElementId)
Sets the parameter to a new element id.
Public methodSetValueString
Set the parameter value according to the input string.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)

Properties

  NameDescription
Public propertyDefinition
Returns the Definition object that describes the data type, name and other details of the parameter.
Public propertyElement
The element to which this parameter belongs.
Public propertyGUID
The Guid for a shared parameter.
Public propertyHasValue
Identifies if the parameter has an assigned value.
Public propertyId
The id of the parameter.
Public propertyIsReadOnly
Get the readonly property of the parameter.
(Overrides APIObject..::..IsReadOnly.)
Public propertyIsShared
Identifies if the parameter is a shared parameter.
Public propertyStorageType
Describes the type that is used internally within the parameter to store its value.
Public propertyUserModifiable
Indicates whether the interactive user can modify the value of this parameter.

See Also