Parameter

Public Class

The parameter object contains the value data assigned to that parameter.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.APIObject
Autodesk.Revit.DB.Parameter

Namespace: Autodesk.Revit.DB

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class Parameter : APIObject

The Parameter type exposes the following members.

Properties

Name

Description

---

Public Property
Definition

Returns the Definition object that describes the data type, name and other details of the parameter.

---

Public Property

Element

The element to which this parameter belongs.

---

Public Property

GUID

The Guid for a shared parameter.

---

Public Property

HasValue

Identifies if the parameter has an assigned value.

---

Public Property

Id

The id of the parameter.

---

Public Property
IsReadOnly

Get the readonly property of the parameter.
(Overrides

APIObject.IsReadOnly

)

---

Public Property

IsShared

Identifies if the parameter is a shared parameter.

---

Public Property
StorageType

Describes the type that is used internally within the parameter to store its value.

---

Public Property
UserModifiable

Indicates whether the interactive user can modify the value of this parameter.

---

Methods

Name

Description

---

Public Method
AsDouble

Provides access to the double precision number within the parameter.

---

Public Method
AsElementId

Provides access to the Autodesk::Revit::DB::ElementId^ stored within the parameter.

---

Public Method
AsInteger

Provides access to the integer number within the parameter.

---

Public Method
AssociateWithGlobalParameter

Associates this parameter with a global parameter in the same document.

---

Public Method
AsString

Provides access to the string contents of the parameter.

---

Public Method
Code Example

AsValueString.

Get the parameter value as a string with units.

---

Public Method

AsValueString(FormatOptions)

Get the parameter value as a string with units.

---

Public Method
CanBeAssociatedWithGlobalParameter

Tests whether this parameter can be associated with the given global parameter.

---

Public Method
CanBeAssociatedWithGlobalParameters

Tests whether this parameter can be associated with any global parameter.

---

Public Method
ClearValue

Clears the parameter to its initial value.

---

Public Method
Dispose

Causes the object to release immediately any resources it may be utilizing.
(Inherited from APIObject)

---

Public Method
DissociateFromGlobalParameter

Dissociates this parameter from a global parameter.

---

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

---

Public Method
GetAssociatedGlobalParameter

Returns a global parameter, if any, currently associated with this parameter.

---

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

---

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

---

Public Method

GetTypeId

Gets the identifier of the parameter.

---

Public Method
GetUnitTypeId

Gets the identifier of the unit quantifying the parameter value.

---

Public Method
Code Example
Set(Double)

Sets the parameter to a new real number value.

---

Public Method
Set(ElementId)

Sets the parameter to a new element id.

---

Public Method
Set(Int32)

Sets the parameter to a new integer value.

---

Public Method
Code Example
Set(String)

Sets the parameter to a new string of text.

---

Public Method
Static Member
SetMultiple

Sets multiple parameters to new values.

---

Public Method
Code Example
SetValueString

Set the parameter value according to the input string.

---

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

---

Remarks

The piece of data contained within the parameter can be either a Double, Integer, String or ElementId. The parameter object can be retrieved from any Element object using either a built in id, definition object or shared parameter guid. All Elements within Autodesk Revit contain Parameters. These are options that can be accessed in a generic fashion. Revit contains many built in parameter types but users and now developers, via the API, can add their own parameters in the form of shared parameters. The developer should become familiar with the Revit user interface for added and managing parameters and shared parameters before using this API. The user interface components can be found in the following locations: Element Properties dialog, Shared Parameters dialog (available from the File menu), Project Parameters dialog (available from the Settings menu), Family Types dialog (available from the Settings menu when editing a family). There are several relationships between the objects that make up the APIs exposure of parameters. The parameter object contains the data value. Parameter objects can be retrieved from Elements if you know its built-in id, its definition or its shared parameter guid. Each parameter has a definition. New parameters can be added to Elements by adding a ParameterBinding object to the Document object.