Export (0) Print
Expand All

DimensionCollection Class

Contains a read-only, on-demand collection of Dimension objects contained in a CubeDef.

Object
  Microsoft.AnalysisServices.AdomdClient.DimensionCollection

Namespace:  Microsoft.AnalysisServices.AdomdClient
Assembly:  Microsoft.AnalysisServices.AdomdClient (in Microsoft.AnalysisServices.AdomdClient.dll)

public sealed class DimensionCollection : ICollection, 
	IEnumerable

The DimensionCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of Dimension objects in the collection.
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized (thread safe).
Public propertyItem[Int32]Gets the Dimension from the collection by its index. In C#, this property is the indexer for the DimensionCollection class.
Public propertyItem[String]Gets the Dimensionfrom the collection by its name. In C#, this property is the indexer for the DimensionCollection class.
Public propertySyncRootGets an object that can be used to synchronize access to the collection.
Top

  NameDescription
Public methodCopyToCopies the elements of the collection to the specified array.
Public methodEquals (Inherited from Object.)
Public methodFindGets the Dimension from the collection by its name.
Public methodGetEnumeratorGets an Enumerator for iterating through the collection.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICollectionCopyToCopies the elements of the DimensionCollection to an array, starting at a particular array index.
Explicit interface implemetationPrivate methodIEnumerableGetEnumeratorGets an enumerator for iterating through the DimensionCollection.
Top

The following subroutine, given a CubeDef, iterates through the DimensionCollection collection and displays information about each dimension:

Public Sub ListDimensionCollection(ByRef CubeToCheck As CubeDef)

    ' Check the parameter before performing actions on it.
    If CubeToCheck Is Nothing Then
        Throw New System.ArgumentNullException("CubeToCheck")
    Else
        ' Iterate through the Dimensions collection of the
        ' CubeDef object.

        Try
            Dim dimToCheck As Dimension

            Debug.WriteLine("Found " & CubeToCheck.Dimensions.Count & _
                " dimensions in cube:")

            For Each dimToCheck In CubeToCheck.Dimensions
                Debug.WriteLine("Dimension:  " & dimToCheck.Name)
                Debug.WriteLine("  Caption:        " & _
                    dimToCheck.Caption)
                Debug.WriteLine("  Description:    " & _
                    dimToCheck.Description)
                Debug.WriteLine("  UniqueName:     " & _
                    dimToCheck.UniqueName)
                Debug.WriteLine("  The dimension " & _
                    IIf(dimToCheck.WriteEnabled = True, "is", "is not") & _
                    " write-enabled.")
            Next
        Catch ex As AdomdConnectionException
            ' The connection could not be opened or was disconnected.
            ' This error can occur at any time, if the provider is 
            ' disconnected from the server.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdErrorResponseException
            ' A response is received from a provider which indicates an error.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdUnknownResponseException
            ' A response has been returned from the provider that 
            ' was not understood.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdCacheExpiredException
            ' A cached version of an ADOMD.NET object is no longer valid.
            ' This error is typically raised when reviewing metadata.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdException
            ' Any other error raised by ADOMD.NET.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As Exception
            ' Any other error.
            Debug.WriteLine(ex)
            Throw ex
        End Try
    End If
End Sub

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft