CellPropertyCollection Class

Article
02/01/2013

Contains a collection of CellProperty objects contained by a Cell.

Inheritance Hierarchy

System.Object
Microsoft.AnalysisServices.AdomdClient.CellPropertyCollection

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

Syntax

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

public sealed class CellPropertyCollection : ICollection, 
    IEnumerable

public ref class CellPropertyCollection sealed : ICollection, 
    IEnumerable

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

public final class CellPropertyCollection implements ICollection, IEnumerable

The CellPropertyCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of CellProperty objects in the collection.
	IsSynchronized	Gets a value indicating whether access to the collection is synchronized (thread safe).
	Item[Int32]	Gets the specified CellProperty from the collection by its index. In Microsoft Visual C#, this property is the indexer for the CellPropertyCollection class.
	Item[String]	Gets the specified CellProperty from the collection by its name. In Microsoft Visual C#, this property is the indexer for the CellPropertyCollection class.
	SyncRoot	Gets an Object that can be used to synchronize access to the collection.

Top

Methods

	Name	Description
	CopyTo	Copies the elements of the collection to the specified array.
	Equals	(Inherited from Object.)
	Find	Gets the specified CellProperty from the collection by its name.
	GetEnumerator	Gets an enumerator for iterating through the collection.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	ICollection.CopyTo	Copies the elements of the CellPropertyCollection to an array, starting at a particular array index.
	IEnumerable.GetEnumerator	Gets an enumerator for iterating through the collection.

Top

Remarks

The CellPropertyCollection is populated when a Cell is created. Each cell in a cellset can have zero or more intrinsic or custom cell properties associated with it, represented by CellProperty objects maintained by the CellPropertyCollection collection.

Examples

The following subroutine iterates through the CellPropertyCollection collection of a specified Cell.

Public Sub ListCellPropertyCollection(ByRef CellToCheck As Cell)
    'Assumes CellToCheck is not null.
    Dim cellProperty As CellProperty

    Debug.WriteLine("Found " & CellToCheck.CellProperties.Count & _
        " cell properties in cell:")

    For Each cellProperty In CellToCheck.CellProperties
        Debug.WriteLine("  Name:  " & cellProperty.Name)
        Debug.WriteLine(" Value:  " & cellProperty.Value)
    Next
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.

Share via