Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

PropertyCollection Class

 

Gets a read-only collection of Property objects contained by a CellSet.

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

System.Object
  Microsoft.AnalysisServices.AdomdClient.PropertyCollection

public sealed class PropertyCollection : ICollection, IEnumerable

NameDescription
System_CAPS_pubpropertyCount

Gets the number of Property objects in the collection.

System_CAPS_pubpropertyIsSynchronized

Gets a value indicating whether access to the collection is synchronized (thread safe).

System_CAPS_pubpropertyItem[Int32]

Gets the specified Property from the PropertyCollection collection by its index. In Microsoft Visual C#, this property is the indexer for the PropertyCollection class.

System_CAPS_pubpropertyItem[String]

Gets the specified Property from the PropertyCollection collection by its name. In Microsoft Visual C#, this property is the indexer for the PropertyCollection class.

System_CAPS_pubpropertySyncRoot

Gets an object that can be used to synchronize access to the PropertyCollection collection.

NameDescription
System_CAPS_pubmethodCopyTo(Property[], Int32)

Copies the elements of the PropertyCollection collection to the specified array.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodFind(String)

Gets the specified Property from the PropertyCollection collection by its name.

System_CAPS_pubmethodGetEnumerator()

Gets an Enumerator for iterating through the PropertyCollection collection.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies the elements of the PropertyCollection to the specified array, starting at a particular array index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Gets an enumerator that iterates through the PropertyCollection.

The PropertyCollection is used by a CellSet to represent the axes returned by a query. Each Property contained by an PropertyCollection represents a set of congruent tuples organized along one or more hierarchies.

System_CAPS_noteNote

The filter Property is not contained in this collection. To access the filter Property, you must reference the OlapInfo.AxesInfo.FilterAxes property of the CellSet.

Legacy Code Example

The following subroutine, given a CellSet, iterates through the PropertyCollection (represented by the Axes property of the CellSet) and displays information for each Property.

Public Sub ListAxes(ByRef cellsetToCheck As CellSet)

    ' Check the parameter before performing actions on it.
    If cellsetToCheck Is Nothing Then
        Throw New System.ArgumentNullException("cellsetToCheck")
    Else
        ' Iterate through the axes of the
        ' CellSet object. The Axes property of the 
        ' CellSet object returns a reference to the
        ' PropertyCollection object.

        Try
            Dim PropertyToCheck As Property

            Debug.WriteLine("Found " & cellsetToCheck.Axes.Count & _
                " axes in cellset:")

            For Each PropertyToCheck In cellsetToCheck.Axes

                Debug.WriteLine("  Name:  " & _
                    PropertyToCheck.Name)
            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.

Return to top

Community Additions

Show:
© 2015 Microsoft