Biml API Reference
AstConnectionBaseNode Type
BimlStudio 2017

AstConnectionBaseNode is the base type for all connection types that are defined in the Biml framework.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Language Element:
AstConnectionBaseNode is an abstract type, so it does not have a corresponding Biml 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)
CreateInProject
This value specifies whether the Connection should be created as a ConnectionManager within each SSIS package that uses it or as a shared ConnectionManager for each project that uses it.
CreateInProjectDefaultValue
Gets the default value for the CreateInProject property
CreatePackageConfiguration
This value specifies whether a PackageConfiguration should be created for this connection.
CreatePackageConfigurationDefaultValue
Gets the default value for the CreatePackageConfiguration property
DelayValidation
This value indicates that the connection should not be validated (tested to make sure that it points to a valid resource) until immediately before it is used.
DelayValidationDefaultValue
Gets the default value for the DelayValidation property
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)
ExpressionProperties
This collection holds properties that can be referenced by expressions. It's not necessarily the same properties that are available directly on the object. These AstPropertyNodes are here to support binding, not to be confused with the Properties collection on the generic control flow base object, which has "real" AstPropertyNodes.
Expressions
This is a collection of SSIS expression definitions for connection property value overrides.
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
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
ImportedScopeChildren
Gets this ScopeBoundary's referenceable items. This is used to notify the children items when this item's ScopedName changes.
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)
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
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
LogicalDisplayFolder
Specifies a path that should be used for organizing the tree display of this object in the Logical View in BimlStudio.
LogicalDisplayFolderDefaultValue
Gets the default value for the LogicalDisplayFolder property
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)
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)
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)
RefId
Returns the SSIS refid that is used to reference this item from within an SSIS package.
RenderedConnectionString
Gets the full connection string for this connection
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)
ScriptName
Gets the name to use for the emitted connection in a Script Component reference. It is equivalent to the buffer name but with illegal C#/VB characters removed.
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)
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)
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:
ConnectionBase
Abstract:
True
Referenceable:
True
Root Item:
False
Scope Boundary:
True
Symbol Table Provider:
False
Biml Language Metadata
Xml Schema Name:
Varigence.Languages.Biml.Connection.AstConnectionBaseNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
True