• Article

CellCollection Class

Contains a read-only collection of Cell objects contained by a CellSet.

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.AdomdClient.CellCollection

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

Syntax

'Declaration
Public NotInheritable Class CellCollection _
    Implements ICollection, IEnumerable
'Usage
Dim instance As CellCollection

public sealed class CellCollection : ICollection, 
    IEnumerable

public ref class CellCollection sealed : ICollection, 
    IEnumerable

[<SealedAttribute>]
type CellCollection =  
    class
        interface ICollection
        interface IEnumerable
    end

public final class CellCollection implements ICollection, IEnumerable

The CellCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of Cell objects in the collection.
Public property IsSynchronized Gets a value indicating whether access to the collection is synchronized (thread safe).
Public property Item[ICollection] Gets the specified Cell from the collection by an ICollection interface that contains a collection of absolute axis indexes. In Microsoft Visual C#, this property is the indexer for the CellCollection class.
Public property Item[Int32] Gets the specified Cell from the collection by its index. In Microsoft Visual C#, this property is the indexer for the CellCollection class.
Public property Item[array<Int32[]] Gets the specified Cell from the collection by an array of absolute axis indexes.
Public property Item[Int32, Int32] Gets the specified Cell from the collection by its coordinate.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection.

Top

Methods

  Name Description
Public method CopyTo Copies the elements of the collection to the specified array.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator Gets an enumerator for iterating through the collection.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator

Top

Examples

The following subroutine, given a CellSet and the number of cells for which to display information, iterates through the CellCollection collection and displays information for each cell:

Public Sub ListCellCollection(ByRef CellSetToCheck As CellSet, _
    Optional ByVal Count As Integer = 10)

    ' Because cellsets can represent tens of thousands of cells,
    ' the Count parameter limits the output to a 
    ' specified number of cells.

    If CellSetToCheck Is Nothing Then
        Throw New System.ArgumentNullException("CellSetToCheck")
    Else
        ' Iterate through the Hierarchies collection of the
        ' Dimension object.

        Dim cellToCheck As Cell
        Dim cellCount As Long
        Dim cellIndex As Long

        Try
            cellCount = CellSetToCheck.CellCollection.Count
            Debug.WriteLine("Found " & cellCount & _
                " cell(s) in cellset:")

            If cellCount > Count Then cellCount = Count

            If cellCount > 0 Then
                For cellIndex = 0 To cellCount - 1
                    cellToCheck = CellSetToCheck.CellCollection(cellIndex)

                    Debug.WriteLine("  Value:           " & _
                        cellToCheck.Value)
                    Debug.WriteLine("  -- Formatting Properties --")
                    Debug.WriteLine("  BackColor:" & _
                        cellToCheck.CellProperties("BackColor"))
                    Debug.WriteLine("  ForeColor:" & _
                        cellToCheck.CellProperties("ForeColor"))
                    Debug.WriteLine("  FormatString:    " & _
                        cellToCheck.CellProperties("FormatString"))
                    Debug.WriteLine("  FormattedValue:  " & _
                        cellToCheck.FormattedValue)
                Next
            End If
        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)
        Catch ex As AdomdErrorResponseException
            ' A response is received from a provider which indicates an error.
            Debug.WriteLine(ex)
        Catch ex As AdomdUnknownResponseException
            ' A response has been returned from the provider that 
            ' was not understood.
            Debug.WriteLine(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)
        Catch ex As AdomdException
            ' Any other error raised by ADOMD.NET.
            Debug.WriteLine(ex)
        Catch ex As Exception
            ' Any other error.
            Debug.WriteLine(ex)
        End Try
    End If
End Sub

Thread Safety

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