NamedSetCollection Class
TOC
Collapse the table of content
Expand the table of content

NamedSetCollection Class

 

Updated: March 10, 2016

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

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

System.Object
  Microsoft.AnalysisServices.AdomdClient.NamedSetCollection

public sealed class NamedSetCollection : ICollection, IEnumerable

NameDescription
System_CAPS_pubpropertyCount

Gets the number of NamedSet 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 NamedSet from the collection by its index. In C#, this property is the indexer for the NamedSetCollection class.

System_CAPS_pubpropertyItem[String]

Gets the specified NamedSet from the collection by its name. In C#, this property is the indexer for the NamedSetCollection class.

System_CAPS_pubpropertySyncRoot

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

NameDescription
System_CAPS_pubmethodCopyTo(NamedSet[], Int32)

Copies the elements of the collection to the specified array.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodFind(String)

Gets the specified NamedSet from the collection.

System_CAPS_pubmethodGetEnumerator()

Gets an Enumerator for iterating through the 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 NamedSetCollection to the specified array, starting at a particular array index.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Gets an enumerator that iterates through the NamedSetCollection.

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

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
Show:
© 2016 Microsoft