Varigence.com - Documentation

Biml API Reference

AstAdfActivityNode Type

BimlStudio 2017

AstAdfActivityNode is the abstract base type for all Azure Data Factory Activities.

Inheritance Hierarchy

AstNode
- AstNamedNode
  - AstScopeBoundaryNode
    - AstAdfActivityNode

Namespace:

Varigence.Languages.Biml.DataFactory

Assembly:

Biml (in Biml.dll)

Language Element:

AstAdfActivityNode is an abstract type, so it does not have a corresponding Biml language element.

Properties

	Name	Summary
	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)
	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 (Inherited from AstScopeBoundaryNode)
	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)
	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)
	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)
	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)
	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)
	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

Code Namespace:

Varigence.Languages.Biml.DataFactory

Assembly:

Biml

Friendly Name:

AdfActivity

Abstract:

True

Referenceable:

True

Root Item:

False

Scope Boundary:

False

Symbol Table Provider:

False

Biml Language Metadata

Xml Schema Name:

Varigence.Languages.Biml.DataFactory.AstAdfActivityNode

Xsd Namespace:

http://schemas.varigence.com/biml.xsd

Referenceable:

True

Scope Boundary:

False

Join our newsletter to stay up with the latest product releases!

Join our newsletter to
stay up with the latest
product releases!