List of dimension value IDs.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class DimValIdList : IList, ICollection, IEnumerable
<SerializableAttribute> _ Public Class DimValIdList _ Implements IList, ICollection, IEnumerable
[SerializableAttribute] public ref class DimValIdList : IList, ICollection, IEnumerable
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | DimValIdListDimValIdListNew()() |
Default constructor that will contain an empty list.
|
| DimValIdListDimValIdListNew(String) |
Constructor that takes a string-based set of dimension value IDs.
The constructor parses and populates the list with the string.
|
| DimValIdListDimValIdListNew(DimValList) |
Constructor that takes a dimension value list and
extracts the IDs from the DimVal objects
in the list.
|
| Add(Object) |
This operation is not supported.
|
| AddDimValue(DimVal) |
Adds a dimension value ID to the DimValIdList.
The ID is extracted from val,
which is a dimension value.
|
| AddDimValueId(Int64) |
Adds a dimension value ID to the DimValIdList.
|
| Clear()() |
Removes all the elements from the DimValIdList.
|
| Contains(Object) |
Determines whether an element is in the DimValIdList.
|
| CopyTo(Array, Int32) |
Copies the entire DimValIdList to a compatible one-dimensional
Array, starting at the specified index of the target array.
|
 | Count |
Gets the number of elements actually contained in the DimValIdList.
|
| Equals(Object) | (Inherited from Object.) |
 | Finalize()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator()() |
Returns an enumerator for the entire DimValIdList.
|
| GetHashCode()() | Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType()() | Gets the Type of the current instance. (Inherited from Object.) |
| IndexOf(Object) |
Returns the zero-based index of the first occurrence of a value
in the DimValIdList or in a portion of it.
|
| Insert(Int32, Object) |
This operation is not supported.
|
| IsFixedSize |
Gets a value indicating whether the
DimValIdList has a fixed size.
|
| IsReadOnly |
Gets a value indicating whether the
DimValIdList is read-only.
|
| IsSynchronized |
Gets a value indicating whether access to the DimValIdList
is synchronized (thread-safe).
|
| Item[([Int32])] |
Gets the Int64 at the specified index.
The set operation is not supported.
|
| MemberwiseClone()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Remove(Object) |
This operation is not supported.
|
| RemoveAt(Int32) |
Removes the element at the specified index of the DimValIdList.
|
| SyncRoot |
This operation is not supported.
|
| ToString()() |
Generates the string-based representation of
the DimValIdList by returning
a space-delimited sequence of dimension value IDs.
|
Remarks
Every dimension value (DimVal object) has a unique ID.
A DimValIdList object contains a list of dimension value IDs.
Typically, the developer does not create and populate the DimValIdList object,
but instead it is returned by get properties such as
DimSearchDimensions.
Note that while DimValIdList objects are lists of dimension
value IDs, DimValList objects are lists of the
actual dimension values.
DimValIdList objects are primarily used to generate MDEX Engine queries. For example, dimension value IDs are used before executing a basic navigation query, as the input argument to the NavDescriptors property setter. There will be a one-to-one mapping between the IDs in the DimValIdList argument and the dimension values (DimVal objects) that are returned by the query.
Inheritance Hierarchy| Object | |
 | DimValIdList |