Retrieves the value of the field in the entity.
Namespace: Autodesk.Revit.DB.ExtensibleStorageAssembly: RevitAPI (in RevitAPI.dll) Version: 23.0.0.0 (23.1.0.0)
Since: 2012
Syntax
C# |
---|
public FieldType Get<FieldType>( Field field, ForgeTypeId unitTypeId ) |
Visual Basic |
---|
Public Function Get(Of FieldType) ( _ field As Field, _ unitTypeId As ForgeTypeId _ ) As FieldType |
Visual C++ |
---|
public: generic<typename FieldType> FieldType Get( Field^ field, ForgeTypeId^ unitTypeId ) |
Parameters
- field
- Type: Autodesk.Revit.DB.ExtensibleStorage..::..Field
The field to retrieve.
- unitTypeId
- Type: Autodesk.Revit.DB..::..ForgeTypeId
Identifier of the unit to which the value will be converted before returning. Must be compatible with the spec specified when creating the Schema.
Type Parameters
- FieldType
- The type of the field
Remarks
The template parameter must match the type of the field (specified when creating the Schema) exactly; this method does not perform data type conversions. The types for containers are IList for arrays and IDictionary for maps.
Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was NULL |
Autodesk.Revit.Exceptions..::..InvalidOperationException | The Field belongs to a different Schema from this Entity, or this Entity is invalid. |
Autodesk.Revit.Exceptions..::..ArgumentException | Requested type does not match the field type. |
Autodesk.Revit.Exceptions..::..ArgumentException | The unitTypeId value is not compatible with the field description. |
Autodesk.Revit.Exceptions..::..ArgumentException | This field's subschema prevents reading. |