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

Documentation

Support Forums
What can we help you with?
Topics

Class AstActionNode

Action objects represent actions that are stored on the Analysis Services cube and executed by client applications such as Microsoft Excel.

Namespace:
Varigence.Languages.Biml.Cube.Action
Assembly:
Biml.dll
C#
    public abstract class AstActionNode : AstNamedNode, IBindableItem, IGetJsonProvider, INamedNode, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem
    
  
Inheritance
System.Object
AstNode
AstNamedNode
AstActionNode
Derived
AstActionNode
AstDrillThroughActionNode
AstReportActionNode
AstStandardActionNode
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

Application

This value associates an action with a specific client application.

ApplicationDefaultValue

Gets the default value for the Application property

Caption

This value provides a caption to be displayed for the action.

CaptionDefaultValue

Gets the default value for the Caption property

CaptionIsMdx

This value specifies whether the caption is a Multidimensional Expressions (MDX) expression. The default value is False.

CaptionIsMdxDefaultValue

Gets the default value for the CaptionIsMdx property

Condition

This value contains a Multidimensional Expressions (MDX) expression that indicates whether the action applies to the target specified in the Target property.

ConditionDefaultValue

Gets the default value for the Condition property

Description

This value provides a description to be displayed for the action.

DescriptionDefaultValue

Gets the default value for the Description property

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

Invocation

This value indicates how and when the action is called.

InvocationDefaultValue

Gets the default value for the Invocation property

Target

This value identifies the specific cube, dimension, hierarchy, or level that is associated with an action.

TargetDefaultValue

Gets the default value for the Target property

TargetType

This value specifies what type of object the target is.

TargetTypeDefaultValue

Gets the default value for the TargetType property

Translations

This value contains alternate language versions of measure groups, measures, cube dimension, perspectives, KPIs, actions, named sets, and calculated members associated with a dimension. These are used by client applications such as Microsoft Excel to show values for dimension metadata that are consistent with the language of the end-user.

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

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.

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