Revit 2025.3 API
Schema |
Sets the documentation string for the Schema.
Namespace: Autodesk.Revit.DB.ExtensibleStorage
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.3.0.0 (25.3.0.0)
Syntax
public SchemaBuilder SetDocumentation( string documentation )
Public Function SetDocumentation ( documentation As String ) As SchemaBuilder
public: SchemaBuilder^ SetDocumentation( String^ documentation )
member SetDocumentation : documentation : string -> SchemaBuilder
Parameters
- documentation String
- The documentation string.
Return Value
SchemaBuilderThe SchemaBuilder object may be used to add more settings.
Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | A non-optional argument was null |
| InvalidOperationException | The SchemaBuilder has already finished building the Schema. |
Remarks
While Entities may be hidden using access levels, Schemas and Fields are visible to
clients and other developers. In the interest of clarity and interoperability, you are
very strongly encouraged to provide good documentation with your Schemas.
Explain the intent of the data and how it is meant to be interpreted. It is not
useful to repeat information that can be observed directly (e.g. types and units).
Note that documentation, like all other contents of Schemas and Fields is immutable
once the add-in using the Schema is published.
See Also