The Entity type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| Entity()()()() |
The default-constructed Entity is invalid.
| |
| Entity(Guid) |
Creates a new Entity corresponding to the Schema of the specified GUID.
| |
| Entity(Entity) |
Constructs a new copy of the input ESEntity object.
| |
| Entity(Schema) |
Creates a new Entity corresponding to the Schema.
|
Methods
| Name | Description | |
|---|---|---|
| Clear(String) |
Resets the field to its default value.
| |
| Clear(Field) |
Resets the field to its default value.
| |
| Dispose | Releases all resources used by the Entity | |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
| Get<(Of <<'(FieldType>)>>)(String) |
Retrieves the value of the field in the entity.
| |
| Get<(Of <<'(FieldType>)>>)(Field) |
Retrieves the value of the field in the entity.
| |
| Get<(Of <<'(FieldType>)>>)(String, DisplayUnitType) | Obsolete.
Retrieves the value of the field in the entity.
| |
| Get<(Of <<'(FieldType>)>>)(String, ForgeTypeId) |
Retrieves the value of the field in the entity.
| |
| Get<(Of <<'(FieldType>)>>)(Field, DisplayUnitType) | Obsolete.
Retrieves the value of the field in the entity.
| |
| Get<(Of <<'(FieldType>)>>)(Field, ForgeTypeId) |
Retrieves the value of the field in the entity.
| |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| IsValid |
Checks whether this Entity has a live Schema corresponding to it.
| |
| ReadAccessGranted |
Checks whether this Entity may be retrieved by the current add-in.
| |
| RecognizedField |
Checks whether a Field belongs to the same Schema as this Entity.
| |
| Set<(Of <<'(FieldType>)>>)(String, FieldType) |
Stores the value of the field in the entity.
| |
| Set<(Of <<'(FieldType>)>>)(Field, FieldType) |
Stores the value of the field in the entity.
| |
| Set<(Of <<'(FieldType>)>>)(String, FieldType, DisplayUnitType) | Obsolete.
Stores the value of the field in the entity.
| |
| Set<(Of <<'(FieldType>)>>)(String, FieldType, ForgeTypeId) |
Stores the value of the field in the entity.
| |
| Set<(Of <<'(FieldType>)>>)(Field, FieldType, DisplayUnitType) | Obsolete.
Stores the value of the field in the entity.
| |
| Set<(Of <<'(FieldType>)>>)(Field, FieldType, ForgeTypeId) |
Stores the value of the field in the entity.
| |
| ToString | Returns a string that represents the current object. (Inherited from Object.) | |
| WriteAccessGranted |
Checks whether this Entity may be stored by the current add-in.
|
Properties
| Name | Description | |
|---|---|---|
| IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
| |
| Schema |
The Schema describing this Entity.
| |
| SchemaGUID |
The GUID of the Schema describing this Entity.
|