• Article

NamedSetCollection Class

Gets a read-only, on-demand collection of NamedSet objects contained by a CubeDef.

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.AdomdClient.NamedSetCollection

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

Syntax

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

public sealed class NamedSetCollection : ICollection, 
    IEnumerable

public ref class NamedSetCollection sealed : ICollection, 
    IEnumerable

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

public final class NamedSetCollection implements ICollection, IEnumerable

The NamedSetCollection type exposes the following members.

Properties

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

Top

Methods

  Name Description
Public method CopyTo Copies the elements of the collection to the specified array.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method Find Gets the specified NamedSet from the collection.
Public method GetEnumerator Gets an Enumerator for iterating through the collection.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator

Top

Examples

The following subroutine, given a CubeDef, iterates through the NamedSetCollection collection and displays information for each named set.

Public Sub ListNamedSetCollection(ByRef CubeToCheck As CubeDef)

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

        Try
            Dim nsetToCheck As NamedSet

            Debug.WriteLine("Found " & CubeToCheck.NamedSets.Count & _
                " named set(s) in cube:")

            For Each nsetToCheck In CubeToCheck.NamedSets
                Debug.WriteLine("Named Set:  " & nsetToCheck.Name)
                Debug.WriteLine("    Description:  " & _
                    nsetToCheck.Description)
                Debug.WriteLine("    Expression:   " & _
                    nsetToCheck.Expression)
            Next
        Catch e As System.Exception
            Debug.WriteLine(e)
        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.