Biml API Reference
AstVariableNode Type
BimlStudio 2017

The AstVariableNode type corresponds directly to a task variable in SQL Server Integration Services.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Language Element:
Properties
  Name Summary
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)
DataType
This value specifies the type of the variable selected from the list of variable types supported by the system.
(Inherited from AstVariableBaseNode)
Error
Gets the error string for this node, if any
(Inherited from AstNode)
ErrorCount
Gets the count of error diagnostics that have been generated for this node
(Inherited from AstNode)
EvaluateAsExpression
This value specifies whether the string value provided in the Value property and any subsequent value setting should be preprocessed before use. If true, the Value property will be treated as an expression using the SSIS expression syntax.
EvaluateAsExpressionDefaultValue
Gets the default value for the EvaluateAsExpression property
FlowFile
This value specifies the containing code file of this node for Xml Binding purposes.
(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)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstVariableBaseNode)
FriendlyTypeName
Gets the friendly name of the type of this node
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstVariableBaseNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
Id
Allows the developer to specify a unique identifier (GUID) for the variable. This can be used to retain a consistent ID between builds.
(Inherited from AstVariableBaseNode)
IdDefaultValue
Gets the default value for the Id property
(Inherited from AstVariableBaseNode)
IncludeInDebugDump
This value specifies whether the value of this variable will be included in a debug dump.
(Inherited from AstVariableBaseNode)
IncludeInDebugDumpDefaultValue
Gets the default value for the IncludeInDebugDump property
(Inherited from AstVariableBaseNode)
InheritFromPackageParentConfigurationString
This value specifies configuration information necessary to map the specified parent package variable value onto this variable value.
InheritFromPackageParentConfigurationStringDefaultValue
Gets the default value for the InheritFromPackageParentConfigurationString property
IsAstNodeReadOnly
Gets a value indicating whether this node is currently in a read-only state
(Inherited from AstNode)
IsInBrokenLiveBimlScript
Specifies whether or not this object is part of a live BimlScript containing an error, which means that this is a cached object that may be out-of-date
(Inherited from AstNode)
IsSystemVariable
Gets or sets whether this is a system variable, as opposed to a user defined variable.
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
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)
NameDefaultValue
Gets the default value for the Name property
(Inherited from AstNamedNode)
Namespace
This value specifies the namespace to use for the variable definition. A common choice is 'User'.
NamespaceDefaultValue
Gets the default value for the Namespace property
ObjectTag
This property provides a general purpose storage mechanism for .NET objects to be associated with AstNode objects. It supplements the annotation system, which is intended for use with string-based metadata.
(Inherited from AstNode)
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)
ParentXObjectMappingProvider
This value specifies the parent of the current node for Xml Binding purposes.
(Inherited from AstNode)
PropertyChangeNotificationTarget
Gets a reference to the ViewModel object for this node. This property should only be used by the internal Biml framework.
(Inherited from AstNode)
QualifiedName
Gets the fully qualified SSIS name for this variable.
(Inherited from AstVariableBaseNode)
QualifiedName
Gets the fully qualified SSIS name for this variable.
RaiseChangedEvent
This value specifies whether an event will be raised that will cause registered event handlers to execute when the value of this variable changes.
RaiseChangedEventDefaultValue
Gets the default value for the RaiseChangedEvent property
RawXmlValue
This value specifies a default or initial value for the variable. The value string will be automatically converted to the data type specified in TypeCode if possible. If EvaluateAsExpression is set to true, then the SQL Server Integration Services (SSIS) expression for the parent variable shoud be specificed in this property.
(Inherited from AstVariableBaseNode)
RawXmlValueDefaultValue
Gets the default value for the RawXmlValue property
(Inherited from AstVariableBaseNode)
ReadOnly
This value specifies whether the initial variable value is read-only.
ReadOnlyDefaultValue
Gets the default value for the ReadOnly property
ReferenceCount
Gets or sets the total number of other node properties that hold a reference to this node.
(Inherited from AstNamedNode)
References
Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.
(Inherited from AstNamedNode)
RefId
Returns the SSIS refid that is used to reference this item from within an SSIS package or dataflow.
(Inherited from AstNamedNode)
ScopeBoundary
Gets the scope boundary for this node
(Inherited from AstNode)
ScopeBoundary
Gets the ScopeBoundary for this referenceable item
(Inherited from AstNamedNode)
ScopedName
Gets the scoped name which can be used to uniquely identify this object among other objects of its type
(Inherited from AstNamedNode)
ScopedNamePrefix
Gets the prefix to use for ScopedName calculations
(Inherited from AstNamedNode)
SsisSafeName
Returns a version of the Name that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
SsisSafeName
Returns a version of the Name that has been cleaned of invalid characters for SSIS.
SsisSafeScopedName
Returns a version of the ScopedName 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.
SymbolTable
Gets a reference to the symbol table that stores a reference to this and all other named objects in the project
(Inherited from AstNamedNode)
SymbolTableProvider
Gets the symbol table provider for this node
(Inherited from AstNode)
TreeDepth
Gets the distance between this node and the root item
(Inherited from AstNode)
UserDefinedItems
Gets the child items of this node that were defined in user code
(Inherited from AstNode)
Value
This value specifies a default or initial value for the variable. The value string will be automatically converted to the data type specified in DataType if possible. If EvaluateAsExpression is set to true, then the SQL Server Integration Services (SSIS) expression for the parent variable shoud be specificed in this property.
(Inherited from AstVariableBaseNode)
WarningCount
Gets the count of warning diagnostics that have been generated for this node
(Inherited from AstNode)
XmlMapping
Gets the XML binding information that is used to track the Biml code that corresponds to this node
(Inherited from AstNode)
Methods
  Name Summary
Events
  Name Summary
ItemLabelChanged
The ItemLabelChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
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.
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.
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.
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.
Extension Methods
  Name Summary
AddAnnotation(AnnotationType,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
AddAnnotation(AnnotationType,String,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
EnumerateAncestors
Returns the ancestors of the current node
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetBiml()
Retrieve the Biml that represents the AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
.NET API Metadata
Assembly:
Biml
Friendly Name:
Variable
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Task.AstVariableNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False