Export (0) Print
Expand All

MemberPropertyCollection Class

Gets a read-only, on-demand collection of MemberProperty objects contained by a Member.

Object
  Microsoft.AnalysisServices.AdomdClient.MemberPropertyCollection

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

public sealed class MemberPropertyCollection : ICollection, 
	IEnumerable

The MemberPropertyCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of MemberProperty objects in the collection.
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized (thread safe).
Public propertyItem[Int32]Gets the specified MemberProperty from the collection by its index. In C#, this property is the indexer for the MemberPropertyCollection class.
Public propertyItem[String]Gets the specified MemberProperty from the collection by its name. In C#, this property is the indexer for the MemberPropertyCollection 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 methodFindReturns the specified MemberProperty 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 MemberPropertyCollection to the specified array, starting at a particular array index.
Explicit interface implemetationPrivate methodIEnumerableGetEnumeratorGets the enumerator that iterates through the MemberPropertyCollection.
Top

Although the MemberPropertyCollection collection externally represents a collection of MemberProperty objects for a specified Member, the collection is internally loaded and managed in one of two ways, depending on the parentage of the Member:

  • If the Member was referenced through the use of a CubeDef in order to retrieve metadata from the server, the collection represents the member properties that are defined for the level of the member represented by the Member.

  • If the Member was referenced through the use of a CellSet in order to retrieve metadata from a query, the collection represents the member properties that are retrieved for the set (or axis) containing the member represented by the Member.

The following subroutine, given a Member, iterates through the MemberPropertyCollection collection and displays information for each member property:

Public Sub ListMemberPropertyCollection(ByRef MemberToCheck As Member)

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

        Try
            Dim propToCheck As MemberProperty

            Debug.WriteLine("Found " & _
                MemberToCheck.MemberProperties.Count & _
                " member properties in member:")

            For Each propToCheck In MemberToCheck.MemberProperties
                Debug.WriteLine("Member Property:  " & propToCheck.Name)
                Debug.WriteLine("  Value:        " & _
                    propToCheck.Value)
            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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft