BIML API Reference
AstFileFormatNode Node Type
AstFileFormatNode is the base type for all flat file definition formats in the Biml framework.
Inheritance Hierarchy
- Varigence.Languages.Biml.AstNode
- Varigence.Languages.Biml.AstNamedNode
- Varigence.Languages.Biml.FileFormat.AstFileFormatNode
- Varigence.Languages.Biml.FileFormat.AstFlatFileFormatNode
- Varigence.Languages.Biml.FileFormat.AstRawFileFormatNode
Namespace:
Varigence.Languages.Biml.FileFormat
Assembly:
Biml (in Biml.dll)
Language Element:
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) | |
| 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 |
 | Name | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. (Inherited from AstNamedNode) | |
| 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) | |
| ReferenceCount | This value specifies the total number of other node properties that hold a reference to this node. (Inherited from AstNamedNode) | 0 |
| References | This is a collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node. (Inherited from AstNamedNode) | |
| SsisSafeName | Returns a version of the Name that has been cleaned of invalid characters for SSIS. (Inherited from AstNamedNode) | |
| SsisSafeScopedName | Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS. (Inherited from AstNamedNode) |
Events
| Name | Summary | |
|---|---|---|
 | NameChanged | The NameChanged event occurs when the Name property of the current node has changed to a new value and that value has been committed. (Inherited from AstNamedNode) |
| NameChanging | The NameChanging event occurs when the Name property of the current node is receiving a new value but that value has not yet been committed. (Inherited from AstNamedNode) |
| 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) |
| ScopedNameChanged | The ScopedNameChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes. (Inherited from AstNamedNode) |
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.FileFormat
Assembly:
Biml
Friendly Name:
File Format
Abstract:
True
Referenceable:
True
Root Item:
False
Scope Boundary:
True
Symbol Table Provider:
False
BIML Language Metadata
Xml Schema Name:
Varigence.Languages.Biml.FileFormat.AstFileFormatNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
True
Properties Referencing This Type
| Referencing Type | Referencing Property | Property Summary | |
|---|---|---|---|
 | AstRootNode | FileFormats | This is a collection of all file format definitions in the project. |