Skip to content
RevitAPI doc lite

Field

Public Class

The description of a field within a Schema in the Extensible Storage framework. Contains the field’s name, type, access control and documentation.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ExtensibleStorage.Field

Namespace: Autodesk.Revit.DB.ExtensibleStorage

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

Syntax

public class Field : IDisposable

The Field type exposes the following members.

Properties

Name

Description

Public Property

ContainerType

Reports whether this is a simple field containing one value, or a container of multiple values.

Public Property

Documentation

The overall description of the Field.

Public Property

FieldName

The name of the field.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Public Property
KeyType

The type of the keys stored in the field.

Public Property

Schema

The Schema to which this Field belongs.

Public Property

SubSchema

The Schema describing the subentity (or subentities) stored in this Field.

Public Property

SubSchemaGUID

The GUID of the Schema describing the subentity (or subentities) stored in this Field.

Public Property
ValueType

The type of the values stored in the field.

Methods

Name

Description

Public Method

CompatibleUnit

Checks if the specified unit is compatible with the field description.

Public Method

Dispose

Releases all resources used by the Field

Public Method

Equals

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

Public Method

GetHashCode

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

Public Method

GetSpecTypeId

Gets the spec describing the values stored in this field.

Public Method

GetType

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

Public Method

SubEntityReadAccessGranted

Checks whether there is read access to subentities storable in this field.

Public Method

SubEntityWriteAccessGranted

Checks whether there is write access to subentities storable in this field.

Public Method

ToString

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