SchemaBuilder
Description:
This class is used to create Schemas in the Extensible Storage framework.
This class is used to create Schemas in the Extensible Storage framework.
Remarks:
Named parameter idiom: Methods that set up the Schema return a reference to the builder so you can invoke multiple methods in a chain (e.g., builder.setReadAccessLevel(...).setWriteAccessLevel(...)). Methods that add fields return a FieldBuilder instead.
Named parameter idiom: Methods that set up the Schema return a reference to the builder so you can invoke multiple methods in a chain (e.g., builder.setReadAccessLevel(...).setWriteAccessLevel(...)). Methods that add fields return a FieldBuilder instead.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.ExtensibleStorage.SchemaBuilder
System.Object
Autodesk.Revit.DB.ExtensibleStorage.SchemaBuilder
public class SchemaBuilder : IDisposable
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| SchemaBuilder(Guid) | None | Constructs a new SchemaBuilder where the resulting Schema will use the input GUID. |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AcceptableName(String) | Boolean | Checks whether a string is an acceptable name for a Schema or a Field. | |
| AddArrayField(String, Type) | FieldBuilder | Creates a field containing an array of values in the Schema, with given name and type of contained values. | |
| AddMapField(String, Type, Type) | FieldBuilder | Creates a field containing an ordered key-value map in the Schema, with given name and type of contained values. | |
| AddSimpleField(String, Type) | FieldBuilder | Creates a field containing a single value in the Schema, with given name and type. | |
| Dispose() | None | Releases all resources used by the SchemaBuilder | |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| Finish() | Schema | Registers and returns the created Schema object. | |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| GUIDIsValid(Guid) | Boolean | Checks whether the supplied GUID value is valid. | |
| Ready() | Boolean | Checks whether the builder may be used. | |
| SetApplicationGUID(Guid) | SchemaBuilder | Sets the GUID of the application or add-in that may access entities of this Schema under the Application acess level. | |
| SetDocumentation(String) | SchemaBuilder | Sets the documentation string for the Schema. | |
| SetReadAccessLevel(AccessLevel) | SchemaBuilder | Sets top level read access (for entities) | |
| SetSchemaName(String) | SchemaBuilder | Sets the name of the Schema. | |
| SetVendorId(String) | SchemaBuilder | Sets the ID of the third-party vendor that may access entities of this Schema under the Vendor acess level, and to generally identify the owner of this Schema. | |
| SetWriteAccessLevel(AccessLevel) | SchemaBuilder | Sets top level write access (for entities) | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| VendorIdIsValid(String) | Boolean | Checks whether the given vendor ID string is valid. A valid vendor ID string: 1. Has a length of at least 4 characters and no more than 253 characters, and 2. Contains only letters, digits, or any of the following special characters: ! " # & \ ( ) + , . - : ; < = > ? _ ` | ~ |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. |