Biml API Reference
AstSsisPackagePartBaseNode Type
BimlStudio 2017

The Package Part Base type provides an abstract base type for all SSIS package parts.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Language Element:
Properties
  Name Summary
BimlFile
This value specifies the BimlFile in which the Biml code that defines AstNode resides.
(Inherited from AstNode)
CanAutoLayoutMoveSinkAnchors
Gets a value to indicate whether autolayout is permitted to rearrange sink anchors on the design surface to reduce edge overlapping
(Inherited from AstTaskNode)
CanAutoLayoutMoveSourceAnchors
Gets a value to indicate whether autolayout is permitted to rearrange source anchors on the design surface to reduce edge overlapping
(Inherited from AstTaskNode)
ConstraintModeDefaultValue
Gets the default value for the ConstraintMode property
(Inherited from AstContainerTaskBaseNode)
ContainerTasks
Gets a collection of all child tasks of this container that are themselves either container tasks or dataflow tasks
(Inherited from AstContainerTaskBaseNode)
DelayValidationDefaultValue
Gets the default value for the DelayValidation property
(Inherited from AstTaskNode)
DisabledDefaultValue
Gets the default value for the Disabled property
(Inherited from AstTaskNode)
DisableEventHandlersDefaultValue
Gets the default value for the DisableEventHandlers property
(Inherited from AstTaskNode)
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.
(Inherited from AstTaskNode)
FailPackageOnFailureDefaultValue
Gets the default value for the FailPackageOnFailure property
(Inherited from AstTaskNode)
FailParentOnFailureDefaultValue
Gets the default value for the FailParentOnFailure property
(Inherited from AstTaskNode)
FlowFile
This value specifies the containing code file of this node for Xml Binding purposes.
(Inherited from AstNode)
ForcedExecutionValueDefaultValue
Gets the default value for the ForcedExecutionValue property
(Inherited from AstTaskNode)
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)
ForceExecutionResultDefaultValue
Gets the default value for the ForceExecutionResult property
(Inherited from AstTaskNode)
ForceExecutionValueDefaultValue
Gets the default value for the ForceExecutionValue property
(Inherited from AstTaskNode)
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 AstScopeBoundaryNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstTaskNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstContainerTaskBaseNode)
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 AstScopeBoundaryNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstTaskNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstContainerTaskBaseNode)
IdDefaultValue
Gets the default value for the Id property
(Inherited from AstTaskNode)
ImportedScopeChildren
Gets this ScopeBoundary's referenceable items. This is used to notify the children items when this item's ScopedName changes.
(Inherited from AstScopeBoundaryNode)
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)
IsolationLevelDefaultValue
Gets the default value for the IsolationLevel property
(Inherited from AstTaskNode)
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
LanguageDefaultValue
Gets the default value for the Language property
(Inherited from AstTaskNode)
LoggingModeDefaultValue
Gets the default value for the LoggingMode property
(Inherited from AstTaskNode)
MaximumErrorCountDefaultValue
Gets the default value for the MaximumErrorCount property
(Inherited from AstTaskNode)
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
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)
OutputPath
Gets a default OutputPath that all subsequent nodes will connect to, if they choose to create a precendence constraint
(Inherited from AstTaskNode)
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)
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)
SsisSafeScopedName
Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
(Inherited from AstTaskNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
(Inherited from AstContainerTaskBaseNode)
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)
SystemVariables
Gets a collection of all variables defined in this task that have been provided by SSIS as system variables
(Inherited from AstTaskNode)
TransactionModeDefaultValue
Gets the default value for the TransactionMode property
(Inherited from AstTaskNode)
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)
VisiblePackageParameters
Gets a collection of all package parameter nodes that are available to be used by this task.
(Inherited from AstTaskNode)
VisibleProjectParameters
Gets a collection of all project parameter nodes that are available to be used by this task. This include all parameters defined by all package projects that contain the parent package for this task.
(Inherited from AstTaskNode)
VisibleVariables
Gets a collection of all variable nodes that are available to be used by this task. It includes variables defined by this task and any tasks/packages that contain this task
(Inherited from AstTaskNode)
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]
GetSinks
Returns the sink nodes of the task graph
[Extension Method: Import namespace Varigence.Biml.DataflowEngine]
GetSources
Returns the source nodes of the task graph
[Extension Method: Import namespace Varigence.Biml.DataflowEngine]
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:
SsisPackagePartBase
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Task.AstSsisPackagePartBaseNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False