Schema
Description:
The description of a single object (Entity) in the Extensible Storage framework. Contains identity information, documentation and the list of fields to be stored in the Entity.
The description of a single object (Entity) in the Extensible Storage framework. Contains identity information, documentation and the list of fields to be stored in the Entity.
Remarks:
A Schema is similar to a class in most object-oriented languages, or to a C struct, while an Entity is an object of that class. The Schema object is immutable. To create and populate a Schema, use the SchemaBuilder class. Schemas are stored in the memory of the running instance of Revit and may be retrieved with the Lookup method. When a document containing Entities of a Schema is saved, the Schema is saved with the document too. Opening that document reintroduces the Schema into memory. As you plan to store your data in Revit, please be aware that the data will be stored in Revit elements. Overwhelming the Revit database will impact performance and stability, and will make the user unhappy. Also, remember that multiple add-ins may be storing their data simultaneously. Several kB per element or several MB per file are reasonable maximums for one add-in. If you have larger requirements, consider storing them in a separate database (such as SQLite) and storing keys into that database in Revit.
A Schema is similar to a class in most object-oriented languages, or to a C struct, while an Entity is an object of that class. The Schema object is immutable. To create and populate a Schema, use the SchemaBuilder class. Schemas are stored in the memory of the running instance of Revit and may be retrieved with the Lookup method. When a document containing Entities of a Schema is saved, the Schema is saved with the document too. Opening that document reintroduces the Schema into memory. As you plan to store your data in Revit, please be aware that the data will be stored in Revit elements. Overwhelming the Revit database will impact performance and stability, and will make the user unhappy. Also, remember that multiple add-ins may be storing their data simultaneously. Several kB per element or several MB per file are reasonable maximums for one add-in. If you have larger requirements, consider storing them in a separate database (such as SQLite) and storing keys into that database in Revit.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.ExtensibleStorage.Schema
System.Object
Autodesk.Revit.DB.ExtensibleStorage.Schema
public class Schema : IDisposable| Name | Return Type | Description |
|---|---|---|
| Dispose() | None | Releases all resources used by the |
| GetField(String) | The Field | Gets a Field of a given name from the Schema. |
| ListFields() | IList<Field> | The complete list of fields in the Schema, sorted by name. |
| ListSchemas() | IList<Schema> | Lists all schemas in memory. |
| Lookup(Guid) | Schema | Finds the Schema corresponding to the GUID in memory. |
| ReadAccessGranted() | bool | Checks whether Entities of this Schema may be retrieved by the current add-in. |
| WriteAccessGranted() | bool | Checks whether Entities of this Schema may be stored by the current add-in. |
| Name | Return Type | Description |
|---|---|---|
| ApplicationGUID | Guid | The GUID of the application or add-in that may access entities of this Schema under the Application access level. |
| Documentation | string | The overall description of the Schema. |
| GUID | Guid | The identifier of the Schema. Setter made unavailable, because it would violate set-correctness |
| IsValidObject | bool | Specifies whether the .NET object represents a valid Revit entity. |
| ReadAccessLevel | AccessLevel | Read access level of the schema. |
| SchemaName | string | The user-friendly name of the Schema. |
| VendorId | string | The id of the third-party vendor that may access entities of this Schema under the Vendor access level. |
| WriteAccessLevel | AccessLevel | Write access level of the schema. |