Class AstSsisAnnotationNode
AstSsisAnnotationNode corresponds directly to a SQL Server Integration Services design surface text annotation.
Namespace: Varigence.Languages.Biml.Task
Assembly: Biml.dll
C#
public class AstSsisAnnotationNode : AstNode, IBindableItem, IGetJsonProvider, IFrameworkItem, IValidationInfo
Inheritance AstNode
-
Implements
Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, System.ComponentModel.IDataErrorInfo,
Constructors
| Constructors | Description |
|---|---|
| AstSsisAnnotationNode(IFrameworkItem) | Initializes a new instance of the AstSsisAnnotationNode class with the specified parent node. |
Fields
| Fields | Description |
|---|---|
| IsScopeImported |
Properties
| Properties | Description |
|---|---|
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| Guid | |
| 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. |
| 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. |
| BimlFile | This value specifies the BimlFile in which the Biml code that defines AstNode resides. |
| ItemLabel | Gets a label that can be used to identify this node |
| 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. |
Methods
| Methods | Description |
|---|---|
| BindingScopeBoundaries() | Retrieves the permitted scope boundaries to bind references from this node. |
| Duplicate() | Creates a duplicate of the current node |
| Duplicate(IFrameworkItem) | Creates a duplicate of the current node with the specified parent item |
| GetDefaultValue(String) | Retrieves the default value for the property with the name propertyName |
| GetDefaultValue<T>(String) | Retrieves the default value for the property with the name propertyName |
| GetSchemaLocalName() | Retrieves the local XML element name that corresponds to this node in Biml code. |
| StructureEquals(Object) | Compares this node to the provided object to determine if all defined children and references are equal. |
| FirstChildOfType<TChild>() | Gets the first defined descendant node of the specified type |
| RemoveFromParent() | Removes this node definition from its parent |
| DefinedAstNodes() | Retrieves a collection of nodes that have been defined as direct children of the current node. |
| GetJson() | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetExternalJson() | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetJson(Boolean, Boolean, Boolean, Boolean, Boolean) | Generates a JavaScript Object Notation (JSON) representation of the current node |
| GetXObjectName() | Gets the fully qualified XML element name for this node in the code document. |
| FirstParent<TAstNode>() | Retrieves the first parent or ancestor node of the specified type |
| FirstParent<TAstNode>(Type) | Retrieves the first parent or ancestor node of the specified type with the specified custom attribute type |
| FirstThisOrParent<TAstNode>() | Retrieves the first parent or ancestor node of the specified type, including this node |
| IsDirectAncestor(IFrameworkItem) | Retrieves a value indicating whether the specified node is a direct ancestor of this node. |
| AncestorDistance(IFrameworkItem) | Retrieves the number of steps between this node and the nearest shared ancestor with the specified relative node. |
| FirstThisOrParent<TAstNode>(Type) | Retrieves the first parent or ancestor node (including this node) of the specified type with the specified custom attribute type |
| AllDefinedSuccessors() | Retrieves the collection of all nodes defined as a child of this or any successor node or the current node |
| AllDefinedSuccessors(Boolean) | Retrieves the collection of all nodes defined as a child of this or any successor node or optionally the current node |
| OnNotificationTargetPropertyChanged(String) | |
| OnScopeBoundaryChanged(IScopeBoundary, IScopeBoundary) | |
| AddParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| AddScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>) | |
| RemoveScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>) | |
| AddParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| AddFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| RemoveFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>) | |
| GetAllItemsReferencedByDefinedSuccessors() | Builds a list of all items referenced by this node and its successors. Each tuple in the returned list represents a FrameworkItemReference. The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem. |
| ParseChild(XElement, ParserContext) | |
| ParseNameValueMapping(XElement) | |
| BindReference(SymbolTable, String, Boolean, String, Int32, Boolean) |