Biml API Reference
AstSsisAnnotationNode Type
BimlStudio 2017

AstSsisAnnotationNode corresponds directly to a SQL Server Integration Services design surface text annotation.
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)
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)
FlowFile
This value specifies the containing code file of this node for Xml Binding purposes.
(Inherited from AstNode)
FontFamily
Specifies the font family or typeface that should be used to render the annotation text on the SSIS design surface. The default value is Tahoma.
FontFamilyDefaultValue
Gets the default value for the FontFamily property
FontSize
Specifies the point size that should be used to render the annotation text on the SSIS design surface. The default value is 11.
FontSizeDefaultValue
Gets the default value for the FontSize property
FontStyle
Specifies the style that should be used to render the text of the annotation on the SSIS design surface. If the value specified in the FontFamily property does not support the specified FontSyle, the supplied FontStyle value will be ignored. The default value is Regular.
FontStyleDefaultValue
Gets the default value for the FontStyle property
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
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
Height
Specifies the height of the bounding box around the text of the SSIS annotation. If this value is too small or if the Width property value was too small (resulting in text wrapping), the SSIS design surface will override the supplied height value. The default value is 50.
HeightDefaultValue
Gets the default value for the Height 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)
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)
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)
ScopeBoundary
Gets the scope boundary for this node
(Inherited from AstNode)
SymbolTableProvider
Gets the symbol table provider for this node
(Inherited from AstNode)
Text
Specifies the text of the annotation that will be placed on the SSIS design surface.
TextDefaultValue
Gets the default value for the Text property
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)
Width
Specifies the width of the bounding box around the text of the SSIS annotation. If this value is too small, the SSIS design surface will make a best effort to render the annotation, which usually results in wrapping of the annotation text and an increase of the height of the bounding box beyond what was specified in the Height property. The default value is 100.
WidthDefaultValue
Gets the default value for the Width property
X
Specifies the horizontal or x-axis offset of the top-left corner of this SSIS annotation within its parent container. The default is 0.
XDefaultValue
Gets the default value for the X property
XmlMapping
Gets the XML binding information that is used to track the Biml code that corresponds to this node
(Inherited from AstNode)
Y
Specifies the vertical or y-axis offset of the top-left corner of this SSIS annotation within its parent container. The default is 0.
YDefaultValue
Gets the default value for the Y property
Methods
  Name Summary
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.
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:
SsisAnnotation
Abstract:
False
Referenceable:
False
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Task.AstSsisAnnotationNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
False
Scope Boundary:
False