CellCollection Class

Article
12/03/2008

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

Namespace: Microsoft.AnalysisServices.AdomdClient
Assembly: Microsoft.AnalysisServices.AdomdClient (in microsoft.analysisservices.adomdclient.dll)

Syntax

'Declaration
<DefaultMemberAttribute("Item")> _
Public NotInheritable Class CellCollection
    Implements ICollection, IEnumerable

[DefaultMemberAttribute("Item")] 
public sealed class CellCollection : ICollection, IEnumerable

[DefaultMemberAttribute(L"Item")] 
public ref class CellCollection sealed : ICollection, IEnumerable

/** @attribute DefaultMemberAttribute("Item") */ 
public final class CellCollection implements ICollection, IEnumerable

DefaultMemberAttribute("Item") 
public final class CellCollection implements ICollection, IEnumerable

Inheritance Hierarchy

System.Object
Microsoft.AnalysisServices.AdomdClient.CellCollection

Example

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 Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via