Biml API Reference
AstAttributeNode Type
BimlStudio 2017

AstAttributeNode corresponds directly to a SQL Server Analysis Services dimension attribute.
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)
AttributeHierarchyDisplayFolder
This value specifies the folder in which the Attribute Hierarchy associate with this Attribute is listed. The default setting is None. The display folder is used by the OLAP client, such as Microsoft Excel, to visualize the measure in context of the larger measure/dimension hierarchy. Display folders enable better organization of measures to ease the navigation of large cubes for end-user analysts.
AttributeHierarchyDisplayFolderDefaultValue
Gets the default value for the AttributeHierarchyDisplayFolder property
AttributeHierarchyEnabled
This value indicates whether SQL Server Analysis Services will generate an attribute hierarchy. Attribute hierarchies are required for the attribute to participate in a user-defined hierarchy or to be referenced by Multidimensional Expressions (MDX) queries.
AttributeHierarchyEnabledDefaultValue
Gets the default value for the AttributeHierarchyEnabled property
AttributeHierarchyOptimizedState
This value indicates whether SQL Server Analysis Services is to index the attribute hierarchy to enhance query performance. The default setting is FullyOptimized. If the attribute hierarchy will not be queried, select the NotOptimized setting to prevent the generation of indexes for the attribute hierarchy, which can consume additional memory and cube processing time.
AttributeHierarchyOptimizedStateDefaultValue
Gets the default value for the AttributeHierarchyOptimizedState property
AttributeHierarchyOrdered
This value indicates whether the attribute hierarchy generated from this attribute is ordered. Ordering large attribute hierarchies can consume significant cube processing time. If the attribute hierarchy will not be used in user-visible query results, or if order does not matter, then ordering can be disabled. The default value is True.
AttributeHierarchyOrderedDefaultValue
Gets the default value for the AttributeHierarchyOrdered property
AttributeHierarchyVisible
Client applications such as Microsoft Excel can present only attribute hierarchies that have been configured with AttributeHierarchyVisible set to True. The default setting is True. If the attribute hierarchy will not be queried and does not need to be visible to analysts in the pivot table interface, then the setting should be changed to False in order to improve processing time.
AttributeHierarchyVisibleDefaultValue
Gets the default value for the AttributeHierarchyVisible property
AttributeType
This value specifies the type of the attribute, which can be selected from a large built-in list of types supplied by Microsoft SQL Server Analysis Services (SSAS). The type is used by the client application in cases where specific attribute types require or permit special handling. Examples of attribute types include those related to time, geography, customers, and accounts.
AttributeTypeDefaultValue
Gets the default value for the AttributeType property
AttributeUsage
This value specifies the role of the attribute relative to its parent dimension. The default setting is Regular.
AttributeUsageDefaultValue
Gets the default value for the AttributeUsage property
BimlFile
This value specifies the BimlFile in which the Biml code that defines AstNode resides.
(Inherited from AstNode)
CanAutoLayoutMoveSinkAnchors
Gets a value to indicate whether autolayout is permitted to rearrange sink anchors on the design surface to reduce edge overlapping
CanAutoLayoutMoveSourceAnchors
Gets a value to indicate whether autolayout is permitted to rearrange source anchors on the design surface to reduce edge overlapping
Columns
Gets a collection of the complete list of referenced columns, including name column, value column, and key columns
CustomRollupColumn
This value indicates which column contains the formula that specifies how member values contribute to their parent's values.
CustomRollupPropertiesColumn
This value indicates which column contains properties used by the formula that specifies how member values contribute to their parent's values.
DefaultMember
This value indicates the Multidimensional Expressions (MDX) value that specifies an attribute's default measure.
DefaultMemberDefaultValue
Gets the default value for the DefaultMember property
Dimension
Gets the AstDimensionNode that is the parent of this item
(Inherited from AstDimensionNamedBaseNode)
DiscretizationBucketCount
This value indicates how many buckets are used to discretize column values.
DiscretizationBucketCountDefaultValue
Gets the default value for the DiscretizationBucketCount property
DiscretizationMethod
This value specifies the method for data discretization.
DiscretizationMethodDefaultValue
Gets the default value for the DiscretizationMethod property
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)
EstimatedCount
This value indicates the estimated number of items in the attribute. The default setting is zero. This value is used to assist in aggregation design choices and other internal operations. While EstimatedCount can be set manually to reflect estimated member counts, BimlStudio also provides an automatic Member Count Estimator in the Cube ribbon.
EstimatedCountDefaultValue
Gets the default value for the EstimatedCount property
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 AstDimensionNamedBaseNode)
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
(Inherited from AstNamedNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstDimensionNamedBaseNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
GroupingBehavior
This value provides user-defined attribute grouping information to OLAP client applications such as Excel.
GroupingBehaviorDefaultValue
Gets the default value for the GroupingBehavior property
InstanceSelection
When client applications visualize the member values for an attribute, they often must commit to using a particular visualization style before all of the data has arrived. For large or small member value lists, the client application might want to use different visualization approaches. To assist with making an appropriate selection, this value communicates the characteristics of the member list before a query is performed.
InstanceSelectionDefaultValue
Gets the default value for the InstanceSelection property
IsAggregatable
This value indicates whether values of attribute members can be aggregated. Specifically, it indicates whether attribute hierarchy contains an (All) level. The default setting is True.
IsAggregatableDefaultValue
Gets the default value for the IsAggregatable 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)
KeyColumns
This value specifies the names of the physical columns from the underlying SQL Server table that define the key and granularity for the attribute. The value specified in this column for each member is the value that users see unless another value is specified for the NameColumn property.
MemberNamesUnique
This value indicates whether the attribute hierarchy is guaranteed to provide unique member names.
MemberNamesUniqueDefaultValue
Gets the default value for the MemberNamesUnique property
MembersWithData
When a parent-child hierarchy is specified, multiple options exist for how the member values that are associated with non-leaf nodes are displayed. This value indicates which approach should be taken.
MembersWithDataCaption
This value gets or sets a template string that parent attributes use to create captions for data members. This value is used only when a parent-child hierarchy has been defined.
MembersWithDataCaptionDefaultValue
Gets the default value for the MembersWithDataCaption property
MembersWithDataDefaultValue
Gets the default value for the MembersWithData property
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
Name
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.
(Inherited from AstNamedNode)
NameColumn
This value indicates which column provides the display name of the attribute. When the key column value for an attribute member is cryptic or not useful, or when the key column is based on a composite key, the NameColumn column can be used instead. This column displays a name that is easily comprehensible to users. The NameColumn property is not used in parent-child hierarchies.
NameDefaultValue
Gets the default value for the Name property
(Inherited from AstNamedNode)
NamingTemplate
This value gets or sets a template string that parent attributes use to create captions for data members. This value is used only when a parent-child hierarchy has been defined.
NamingTemplateDefaultValue
Gets the default value for the NamingTemplate property
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)
OrderBy
This value specifies the method of ordering of members of an attribute, including Key, Name, AttributeKey, and AttributeName.
OrderByAttribute
This value defines the ordering of the members contained in the attribute hierarchy. If the OrderBy property is set to AttributeKey or AttributeName, then this value defines which attribute to use for the key or name ordering. If the OrderBy property is set to Key or Name, this value has no effect.
OrderByDefaultValue
Gets the default value for the OrderBy property
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)
RootMemberIf
This value specifies how the root or topmost members of a parent-child hierarchy are identified. This property value is used only when a parent-child hierarchy has been defined.
RootMemberIfDefaultValue
Gets the default value for the RootMemberIf property
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)
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.
TreeDepth
Gets the distance between this node and the root item
(Inherited from AstNode)
UnaryOperatorColumn
This value specifies how the root or topmost members of a parent-child hierarchy are identified. This property value is used only when a parent-child hierarchy has been defined.
UserDefinedItems
Gets the child items of this node that were defined in user code
(Inherited from AstNode)
ValueColumn
This value indicates which column provides the value of the attribute. Specify the NameColumn element to use the same DataItem values as default values for the ValueColumn element. When the NameColumn element is not specified and the KeyColumns collection contains an element that represents a key column with a string data type, then the same DataItem values are used as default values for the ValueColumn element.
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
Assembly:
Biml
Friendly Name:
Attribute
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Dimension.AstAttributeNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False