Metadata Model Entity Element

API Type:

Varigence.Languages.Biml.Metadata.AstMetadataModelEntityNode

X-Ref:

• Ast Metadata Model Entity Node
• Ast Scope Boundary Node

Attributes

Attribute	API Type	Default	Description
Name	String		Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property
DynamicObjectClassName	String		Specifies the name to use for the wrapper class that is created as part of the dynamic object for this metadata model entity.
IsDocumentationVisible	Boolean	True	Specifies whether or not the autogenerated documentation for the parent metadata model will include this entity.
IsUiEditorVisible	Boolean	True	Specifies whether this entity should be exposed in the editor UI for this metadata model. For instance, in Excel this would correspond to the worksheet for this entity being hidden.
LogicalDisplayFolder	String	string.Empty	Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio.
UiEditorNameComponents	String		Specifies a semicolon separated list of property and relationship names that should be combined to produce a unique name for this entity. This is normally handled by logic included within BimlScripts that consume the metadata. In editor UI contexts, this logic needs to additionally be supplied to the editor so that live validation and other services that rely on unique names can be implemented. If this property is omitted, the Name property is used instead.
UiEditorPageName	String		Specifies the page in the editor UI that should be used to display this entity. For instance, in Excel this would correspond to the worksheet name. If this property is not specified, the name of the entity will be used instead.

Collection Children

Child	API Type	Description
<Annotations>     <Annotation /> </Annotations>	AstAnnotationNode	This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code.
<Properties>     <Property /> </Properties>	AstMetadataModelPropertyNode	This is the collection of properties that add configuration values to the metadata model entity. Using a relational database analogy, if the metadata model entities were tables, properties would be the columns within those tables.
<Relationships>     <Relationship /> </Relationships>	AstMetadataModelEntityRelationshipNode	This is the collection of objects that define the relationships that exist between the parent entity and other entities within the model. Using a relational database analogy, if the metadata model entities were tables, relationships would be foreign keys that relate those tables.
<Validators>     <Validator /> </Validators>	AstMetadataModelValidatorNode	This is a collection of the validator logic objects that will be used to ensure that the metadata model entity is internally consistent and satisfies the constraints imposed by the metadata model.