DimensionAttribute Class

Definition

Describes a dimension attribute. This class cannot be inherited.

[System.Runtime.InteropServices.Guid("DFCB3BDD-51BE-416d-9E6C-3655EBB2845D")]
public sealed class DimensionAttribute : Microsoft.AnalysisServices.NamedComponent, ICloneable
[<System.Runtime.InteropServices.Guid("DFCB3BDD-51BE-416d-9E6C-3655EBB2845D")>]
type DimensionAttribute = class
    inherit NamedComponent
    interface ICloneable
Public NotInheritable Class DimensionAttribute
Inherits NamedComponent
Implements ICloneable
Inheritance
Attributes
Implements

Constructors

DimensionAttribute()

Initializes a new instance of DimensionAttribute using the default values.

DimensionAttribute(String)

Initializes a new instance of DimensionAttribute using the specified name.

DimensionAttribute(String, String)

Initializes a new instance of DimensionAttribute using the specified name and identifier.

Fields

MaxIDLength

Specifies the maximum length of the identifier.

(Inherited from NamedComponent)
MaxNameLength

Specifies the maximum length of the name.

(Inherited from NamedComponent)

Properties

Annotations

Gets a collection within which you can store custom data.

(Inherited from ModelComponent)
AttributeHierarchyDisplayFolder

Gets or sets the folder in which to display the associated attribute hierarchy.

AttributeHierarchyEnabled

Gets or sets whether an attribute hierarchy is enabled for the attribute.

AttributeHierarchyOptimizedState

Gets or sets the level of optimization applied to the attribute hierarchy.

AttributeHierarchyOrdered

Gets or sets an indication whether the associated attribute hierarchy is ordered.

AttributeHierarchyProcessingState

Gets or sets the processing state for the attribute.

AttributeHierarchyVisible

Gets or sets whether the attribute hierarchy is visible to client applications.

AttributeRelationships

Gets the collection of AttributeRelationship objects for the attribute.

CustomRollupColumn

Gets or sets the details of the column that provide a custom rollup formula.

CustomRollupPropertiesColumn

Gets or sets the details of a column that provide the properties of a custom rollup formula.

DataEncodingHint

Gets or sets the data encoding hint.

DefaultMember

Gets or sets an MDX (Multidimensional Expressions) expression that identifies the default member of DimensionAttribute.

DerivedFromColumnId

Gets or sets the derived column identifier for the dimension attributes.

DerivedFromTableId

Gets or sets the derived table identifier of the attributes.

Description

Gets or sets the description of the component.

(Inherited from NamedComponent)
DiscretizationBucketCount

Gets or sets the number of buckets into which to discretize attribute values.

DiscretizationMethod

Gets or sets the method to be used for discretization.

EstimatedCount

Gets or sets the estimated number of members for an attribute.

ExtendedType

Used by client applications that require extensions to the Type property. To use this property, set Type to ExtendedType, and then set ExtendedType to a string value that is understood by your client application. By default, this property is empty.

FormatString

Gets or sets the format item in a specified string.

FriendlyName

Gets a user-friendly name for the component.

(Inherited from NamedComponent)
GroupingBehavior

Gets or sets the grouping behavior for the DimensionAttribute.

HasLineage

Gets or sets a value that indicates whether the dimension attribute has a lineage.

ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
InstanceSelection

Gets or sets a hint to client applications to suggest how a list of items should be displayed, based on the expected number of items in the list.

IsAggregatable

Gets or sets whether the values of the DimensionAttribute object can be aggregated.

KeyColumns

Gets the collection of key column definitions for DimensionAttribute.

KeyForCollection

Gets the key used in collections.

(Inherited from NamedComponent)
KeyUniquenessGuarantee

Gets or sets whether the relationship between the attribute key and its name, and the relationship to related attributes, is guaranteed to be valid.

MemberNamesUnique

Gets or sets an indication whether member names under DimensionAttribute must be unique.

MembersWithData

Gets or sets whether to display data members for non-leaf members in the parent attribute.

MembersWithDataCaption

Gets or sets a template string that is used to create captions for system-generated data members.

Name

Gets or sets the name of the component.

(Inherited from NamedComponent)
NameColumn

Gets or sets the column that provides the name of the DimensionAttribute.

NamingTemplate

Gets or sets how levels are named in a parent-child hierarchy constructed from the DimensionAttribute object.

NamingTemplateTranslations

Gets a collection of localized translations for the NamingTemplate property.

OrderBy

Gets or sets how to order the members contained in the attribute.

OrderByAttribute

Gets or sets the attribute by which to order the members of the attribute hierarchy.

OrderByAttributeID

Gets or sets another attribute by which to order the members of the DimensionAttribute.

OwningCollection

Gets or sets the collection that contains the ModelComponent.

(Inherited from ModelComponent)
Parent

Gets the parent Dimension object of the DimensionAttribute object.

ParentDatabase

Gets the parent Database object of the DimensionAttribute object.

ParentServer

Gets the parent Server object of the DimensionAttribute object.

ProcessingState

Gets or sets the processing state of the attribute.

RootMemberIf

Gets or sets how the root member or members of a parent attribute are identified.

Site

Gets or sets the site associated with the component.

(Inherited from NamedComponent)
SiteID

Gets or sets the identifier for the site associated with the component.

(Inherited from NamedComponent)
SkippedLevelsColumn

Gets or sets the details of a column that stores the number of skipped (empty) levels between each member and its parent.

Source

Gets or sets the source of the attribute.

TokenizationBehavior

Gets or sets the tokenization behavior for this property.

Translations

Gets the collection of Translation objects associated with DimensionAttribute.

Type

Gets or sets the type of the attribute.

UnaryOperatorColumn

Gets or sets the details of a column providing a unary operator.

Usage

Gets or sets how an attribute is used.

UserEditFlag

Gets or sets the user edit flag.

ValueColumn

Gets or sets the column that provides the value of DimensionAttribute.

VertipaqCompressionHint

Gets or sets the vertipaq compression hint.

VisualizationProperties

Gets or sets the properties that can be used by reporting tools to provide enhanced formatting.

Methods

AddToContainer(IContainer)

Adds the ModelComponent object to the specified container.

(Inherited from ModelComponent)
AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.

(Inherited from ModelComponent)
AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.

(Inherited from ModelComponent)
AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.

(Inherited from ModelComponent)
BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.

(Inherited from ModelComponent)
Clone()

Returns a clone of the object.

CopyTo(DimensionAttribute)

Copies the content of this object to another object (the destination).

CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.

(Inherited from ModelComponent)
CopyTo(NamedComponent)

Copies a NamedComponent object to the specified object.

(Inherited from NamedComponent)
RemoveFromContainer(IContainer)

Removes the ModelComponent object from the specified container.

(Inherited from ModelComponent)
Rename(String, FixUpExpressions)

Creates a new name for the dimension attribute.

Reset()

Resets the component to its initial state.

(Inherited from NamedComponent)
Submit()

Submits a ModelComponent object.

(Inherited from ModelComponent)
Submit(Boolean)

Submits a ModelComponent object.

(Inherited from ModelComponent)
ToString()

Returns a string representing the named-component.

(Inherited from NamedComponent)
Validate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.

(Inherited from ModelComponent)
Validate(ValidationErrorCollection, Boolean)

Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors.

(Inherited from ModelComponent)
Validate(ValidationErrorCollection, Boolean, ServerEdition)

Determines whether the DimensionAttribute is valid.

Explicit Interface Implementations

ICloneable.Clone()
IFormattable.ToString(String, IFormatProvider) (Inherited from NamedComponent)
IHostableComponent.Host (Inherited from ModelComponent)
IModelComponent.FriendlyPath (Inherited from ModelComponent)
IModelComponent.OwningCollection (Inherited from ModelComponent)

Applies to