• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Class AstScriptProjectNode

The AstScriptProjectNode is the base class used for all SQL Server Integration Services script project types.

Namespace:
Varigence.Languages.Biml.Script
Assembly:
Biml.dll
C#
    public abstract class AstScriptProjectNode : AstScopeBoundaryNode, IBindableItem, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem
    
  
Inheritance
System.Object
AstNode
AstNamedNode
AstScopeBoundaryNode
AstScriptProjectNode
Derived
AstScriptProjectNode
AstComponentScriptProjectNode
AstTaskScriptProjectNode
Implements

Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, System.ComponentModel.IDataErrorInfo, Varigence.Utility.Collections.IScopedNameIndexable,

Fields

ScopedNamePrefixBackingStore
IsScopeImported

Properties

AssemblyReferences

This is a collection of references to assemblies that will be referenced by the script project.

EntryPoint

This value specifies the name of the method that will server as the entry point for the project assembly.

EntryPointDefaultValue

Gets the default value for the EntryPoint property

Files

This is a collection of file definitions that will be used to build the project.

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

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

ProjectCoreName

This value specifies the name of the script project and its resulting build outputs.

ProjectCoreNameDefaultValue

Gets the default value for the ProjectCoreName property

ReadOnlyVariables

This is a collection of references to variables that will be exposed to the script project user code as read-only variables.

ReadWriteVariables

This is a collection of references to variables that will be exposed to the script project user code as read/write variables.

Resources

This is a collection of embedded resource definitions that will be used to store resource data for the script project.

ScriptLanguage

This value specifies the source code language to use for the script project.

ScriptLanguageDefaultValue

Gets the default value for the ScriptLanguage property

Settings

This is a collection of setting definitions that will be used to store setting data for the script project.

TargetFrameworkVersion

Specifies the target .NET Framework version that should be used for this Script Project. If unspecified, the target version will be selected based on the SSIS target build version.

TargetFrameworkVersionDefaultValue

Gets the default value for the TargetFrameworkVersion property

VstaMajorVersion

Specifies the major version of Visual Studio Tools for Applications (VSTA) to use for emitting the project code. The default is 2 and this should only be changed in advanced emission scenarios.

VstaMajorVersionDefaultValue

Gets the default value for the VstaMajorVersion property

VstaMinorVersion

Specifies the minor version of Visual Studio Tools for Applications (VSTA) to use for emitting the project code. The default is 1 and this should only be changed in advanced emission scenarios.

VstaMinorVersionDefaultValue

Gets the default value for the VstaMinorVersion property

ScopedName

Gets the scoped name which can be used to uniquely identify this object among other objects of its type

SymbolTable

Gets a reference to the symbol table that stores a reference to this and all other named objects in the project

SsisSafeScopedName

Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS.

SsisSafeName

Returns a version of the Name that has been cleaned of invalid characters for SSIS.

Name

Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.

References

Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.

NameDefaultValue

Gets the default value for the Name 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

AddCodeFile()
BindingScopeBoundaries()

Retrieves the permitted scope boundaries to bind references from this node.

DefinedAstNodes()

Retrieves a collection of nodes that have been defined as direct children of the current node.

Duplicate()

Creates a duplicate of the current node

Duplicate(IFrameworkItem)

Creates a duplicate of the current node with the specified parent item

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.

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.

ProjectFullName(String)

Retrieves the name of the project file given a core project name. This primarily includes the application of correct file extension for the language

StructureEquals(Object)

Compares this node to the provided object to determine if all defined children and references are equal.

ToString()

Returns a string that represents the current object. In this case, it is the Name of the node.

OnScopedNameChanged(String, String)
OnItemLabelChanged(String, String)
OnNameChanging(String, String)
OnNameChanged(String, String)
AddScopedNameChangedEventListener(IReferenceableItem, EventHandler<VulcanPropertyChangedEventArgs>)

Adds the scoped name changed event handler to the specified referenceable item.

RemoveScopedNameChangedEventListener(IReferenceableItem, EventHandler<VulcanPropertyChangedEventArgs>)

Removes the scoped name changed event handler from the specified referenceable item.

FirstChildOfType<TChild>()

Gets the first defined descendant node of the specified type

RemoveFromParent()

Removes this node definition from its parent

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>)
ParseSelf(XElement, ParserContext)
ParseNameValueMapping(XElement)
BindReference(SymbolTable, String, Boolean, String, Int32, Boolean)

© Varigence