Article
05/23/2011

LevelPropertyCollection Class

Represents a read-only, on-demand collection of LevelProperty objects contained by a Level.

Inheritance Hierarchy

System.Object
Microsoft.AnalysisServices.AdomdClient.LevelPropertyCollection

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

Syntax

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

public sealed class LevelPropertyCollection : ICollection, 
    IEnumerable

public ref class LevelPropertyCollection sealed : ICollection, 
    IEnumerable

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

public final class LevelPropertyCollection implements ICollection, IEnumerable

The LevelPropertyCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of LevelProperty objects in the collection.
	IsSynchronized	Gets a value indicating whether access to the collection is synchronized (thread safe).
	Item[Int32]	Gets the specified LevelProperty from the collection by its index. In C#, this property is the indexer for the LevelPropertyCollection class.
	Item[String]	Gets the specified LevelProperty from the collection by its name. In C#, this property is the indexer for the LevelPropertyCollection 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.)
	Finalize	(Inherited from Object.)
	Find	Gets the specified LevelProperty from the collection by its name.
	GetEnumerator	Gets an Enumerator for iterating through the collection.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	ICollection.CopyTo
	IEnumerable.GetEnumerator

Top

Examples

The following subroutine, given a Level, iterates through the LevelPropertyCollection collection and displays information about each level property:

Public Overloads Sub ListLevelPropertyCollection(ByRef LevelToCheck As Level)

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

        Try
            Dim propToCheck As LevelProperty

            Debug.WriteLine("Found " & LevelToCheck.LevelProperties.Count & _
                " level properties in level:")

            For Each propToCheck In LevelToCheck.LevelProperties
                Debug.WriteLine("Level Property:  " & propToCheck.Name)
                Debug.WriteLine("  Caption:        " & _
                    propToCheck.Caption)
                Debug.WriteLine("  Description:    " & _
                    propToCheck.Description)
            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

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