Metadata Model Property Element
X-Ref:
- Ast Metadata Model Property Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| DataType | DbType | This value specifies the type of the data stored in this metadata property using the unified type system. The type values include all of those types commonly used in Microsoft SQL Server table definitions. This is a required property | |
| 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 | |
| AllowCustomInput | Boolean | False | Specifies whether the property should allow custom input in those cases where a permitted value set has been specified. If a permitted value set has not been specified, then this property will have no impact. |
| Category | String | Specifies the category or group into which this property should be placed within autogenerated UI. | |
| Default | String | This value specifies a default value for the metadata property. | |
| GroupByPriority | Int32 | 0 | Specifies in what order this property should be used to group data items for the parent entity. Values less than 1 indicate that the property should not participate in grouping. |
| IsDocumentationVisible | Boolean | True | Specifies whether or not the autogenerated documentation for the parent metadata model will include this property. |
| IsRequired | Boolean | False | Specifies whether this property must be specified as part of the metadata model instance or if it is optional. |
| IsUiEditorVisible | Boolean | True | Specifies whether this property should be exposed in the editor UI for this metadata model. For instance, in Excel this would correspond to the field being hidden in the parent entity's worksheet. |
| Length | Int32 | 0 | (Set to -1 to indicate MAX length). This value specifies the length parameter for the DataType associated with this metadata property. This property applies only to DataTypes that support a length specification, such as String and Binary types. |
| PermittedValueSetName | AstMetadataModelPropertyPermittedValueSetNode | Specifies a reference to the permitted value set that will constrain the inputs that can be provided for this property value. If AllowCustomInput is also set to true, then the permitted value set will only be used for completion lists in editor UIs. This references an existing definiton. | |
| Precision | Int32 | 0 | This value specifies the precision parameter for the DataType associated with this metadata property. Precision is the number of digits stored for a numeric value. This property applies only to DataTypes that support precision, such as Decimal. |
| Scale | Int32 | 0 | This value specifies the scale parameter for the DataType associated with this metadata property. Scale is the number of digits to the right of the decimal point in a numeric value. This property applies only to DataTypes that support precision, such as Decimal. |
| SortOrder | Int32 | 0 | Specifies the order of this property relative to the other properties within its Category for placement within the autogenerated UI. |
| UiEditorType | MetadataModelPropertyUiEditorType | Automatic | Specifies the type of editor control that should be used for this property in automatically generated metadata entry UIs. |
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. |
| <Validators> <Validator /> </Validators> | AstMetadataModelValidatorNode | This is a collection of the validator logic objects that will be used to ensure that the metadata model property is internally consistent and satisfies the constraints imposed by the metadata model. |