Class MeasureCollection
Represents the collection of measure objects.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Olap.Data
Assembly: Syncfusion.Olap.Base.dll
Syntax
public class MeasureCollection : CollectionBase, IList, ICollection, IEnumerable<Measure>, IEnumerable
Constructors
MeasureCollection()
Initializes a new instance of the MeasureCollection class.
Declaration
public MeasureCollection()
MeasureCollection(CubeSchema)
Initializes a new instance of the MeasureCollection class.
Declaration
public MeasureCollection(CubeSchema parent_CubeSchema)
Parameters
Type | Name | Description |
---|---|---|
CubeSchema | parent_CubeSchema | The parent cube schema. |
Properties
Item[Int32]
Gets or sets the Measure at the specified index.
Declaration
public Measure this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index of the measure. |
Property Value
Type |
---|
Measure |
Methods
Add(Measure)
Adds the specified measure.
Declaration
public int Add(Measure measure)
Parameters
Type | Name | Description |
---|---|---|
Measure | measure | The measure which is to be added. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the measure object in the current collection. |
Contains(Measure)
Determines whether the collection contains specified measure.
Declaration
public bool Contains(Measure measure)
Parameters
Type | Name | Description |
---|---|---|
Measure | measure | The measure object which is to be searched. |
Returns
Type | Description |
---|---|
System.Boolean |
|
CopyTo(Measure[], Int32)
Copies all the elements of the current collection to the specified one-dimensional array.
Declaration
public void CopyTo(Measure[] measureArray, int index)
Parameters
Type | Name | Description |
---|---|---|
Measure[] | measureArray | The one-dimensional array that is the destination of the elements copied from the current array. |
System.Int32 | index | The index in array at which copying begins. |
FindByName(String)
Finds the measure by its name.
Declaration
public Measure FindByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the measure. |
Returns
Type | Description |
---|---|
Measure | The measure object. |
FindByUniqueName(String)
Finds the measure by its unique name.
Declaration
public Measure FindByUniqueName(string uniqueName)
Parameters
Type | Name | Description |
---|---|---|
System.String | uniqueName | The unique name of the measure. |
Returns
Type | Description |
---|---|
Measure | The measure object. |
GetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
public IEnumerator<Measure> GetEnumerator()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerator<Measure> | A System.Collections.Generic.IEnumerator<> that can be used to iterate through the collection. |
IndexOf(Measure)
Gets the index of the specified measure.
Declaration
public int IndexOf(Measure measure)
Parameters
Type | Name | Description |
---|---|---|
Measure | measure | The measure. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the measure in the collection. |
Insert(Int32, Measure)
Inserts the measure at specified index.
Declaration
public void Insert(int index, Measure measure)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The index at which the measure has to be inserted. |
Measure | measure | The measure object which is to be inserted. |
OnInsertComplete(Int32, Object)
Performs additional custom processes after inserting a new element into the System.Collections.CollectionBase instance.
Declaration
protected override void OnInsertComplete(int index, object value)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index at which to insert |
System.Object | value | The new value of the element at |
Overrides
OnSetComplete(Int32, Object, Object)
Performs additional custom processes after setting a value in the System.Collections.CollectionBase instance.
Declaration
protected override void OnSetComplete(int index, object oldValue, object newValue)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index at which |
System.Object | oldValue | The value to replace with |
System.Object | newValue | The new value of the element at |
Overrides
Remove(Measure)
Removes the specified measure.
Declaration
public void Remove(Measure measure)
Parameters
Type | Name | Description |
---|---|---|
Measure | measure | The measure object which is to be removed. |
RemoveAt(Int32)
Removes the element at the specified index of the System.Collections.CollectionBase instance. This method is not over-ridable.
Declaration
public void RemoveAt(int index)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | index | The zero-based index of the element to remove. |
Exceptions
Type | Condition |
---|---|
System.ArgumentOutOfRangeException |
|