BIML API Reference
AstAnnotationNode Node Type
The AstAnnotationNode type is used to define an annotation item 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.
Inheritance Hierarchy
- Varigence.Languages.Biml.AstNode
- Varigence.Languages.Biml.AstAnnotationNode
Properties
| Name | Summary | Default | |
|---|---|---|---|
 | Annotations | 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. (Inherited from AstNode) | |
| AnnotationType | Specifies the AnnotationType selected from a list of annotation types supported by the system. | Tag |
| BimlFile | This value specifies the BimlFile in which the Biml code that defines AstNode resides. (Inherited from AstNode) | |
| ForceDisableIncrementalChangeTracking | This value specifies whether changes to property values of this node should be automatically reflected in the corresponding Biml code. Its primary use is for temporary nodes that will never be persisted into BimlFiles. (Inherited from AstNode) | False |
| ParentItem | This value specifies the parent of the current node. All nodes must have a valid parent in the Biml framework, except for the root node. (Inherited from AstNode) | |
| Tag | This value specifies the tag that is associated with this annotation. Tags are primarily used for classifying annotation values that will later be used by BimlScripts. | |
 | Text | Specifies the Text of annotation. |
Events
| Name | Summary | |
|---|---|---|
 | ScopeBoundaryChanged | The ScopeBoundaryChanged event occurs when any ancestor (as determined by following ParentItem to the AstRootNode) changes in such a way as the ScopeBoundary for this node changes. This will force the ScopedName of this node to change if it is an AstNamedNode. (Inherited from AstNode) |
Extension Methods
| Name | Summary | |
|---|---|---|
 | GetBiml |
Retrieve the Biml that represents the AstNode
(Inherited from AstNode) [Extension Method: Import namespace Varigence.Hadron.Extensions] |
.NET API Metadata
Code Namespace:
Varigence.Languages.Biml
Assembly:
Biml
Friendly Name:
Annotation
Abstract:
False
Referenceable:
False
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.AstAnnotationNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
False
Scope Boundary:
False
Properties Referencing This Type
| Referencing Type | Referencing Property | Property Summary | |
|---|---|---|---|
 | AstNode | Annotations | 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. |