Class KpiCollection

A Collection of KPI objects

Inheritance
System.Object
System.Collections.CollectionBase
KpiCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IEnumerable<Kpi>
System.Collections.IEnumerable
Inherited Members
System.Collections.CollectionBase.Capacity
System.Collections.CollectionBase.Clear()
System.Collections.CollectionBase.Count
System.Collections.CollectionBase.InnerList
System.Collections.CollectionBase.List
System.Collections.CollectionBase.OnClear()
System.Collections.CollectionBase.OnClearComplete()
System.Collections.CollectionBase.OnInsert(System.Int32, System.Object)
System.Collections.CollectionBase.OnRemove(System.Int32, System.Object)
System.Collections.CollectionBase.OnRemoveComplete(System.Int32, System.Object)
System.Collections.CollectionBase.OnSet(System.Int32, System.Object, System.Object)
System.Collections.CollectionBase.OnValidate(System.Object)
System.Collections.CollectionBase.System.Collections.ICollection.CopyTo(System.Array, System.Int32)
System.Collections.CollectionBase.System.Collections.ICollection.IsSynchronized
System.Collections.CollectionBase.System.Collections.ICollection.SyncRoot
System.Collections.CollectionBase.System.Collections.IList.Add(System.Object)
System.Collections.CollectionBase.System.Collections.IList.Contains(System.Object)
System.Collections.CollectionBase.System.Collections.IList.get_Item(System.Int32)
System.Collections.CollectionBase.System.Collections.IList.IndexOf(System.Object)
System.Collections.CollectionBase.System.Collections.IList.Insert(System.Int32, System.Object)
System.Collections.CollectionBase.System.Collections.IList.IsFixedSize
System.Collections.CollectionBase.System.Collections.IList.IsReadOnly
System.Collections.CollectionBase.System.Collections.IList.Item[System.Int32]
System.Collections.CollectionBase.System.Collections.IList.Remove(System.Object)
System.Collections.CollectionBase.System.Collections.IList.set_Item(System.Int32, System.Object)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Olap.Data
Assembly: Syncfusion.Olap.Base.dll
Syntax
public class KpiCollection : CollectionBase, IList, ICollection, IEnumerable<Kpi>, IEnumerable

Constructors

KpiCollection()

Initializes a new instance of the KpiCollection class.

Declaration
public KpiCollection()

KpiCollection(CubeSchema)

Initializes a new instance of the KpiCollection class.

Declaration
public KpiCollection(CubeSchema parent_CubeSchema)
Parameters
Type Name Description
CubeSchema parent_CubeSchema

The parent cube schema.

Properties

Item[Int32]

Gets or sets the Kpi at the specified index.

Declaration
public Kpi this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index

The index of the KPI.
Property Value
Type
Kpi

Methods

Add(Kpi)

Adds the specified KPI.

Declaration
public int Add(Kpi kpi)
Parameters
Type Name Description
Kpi kpi

The KPI which is to be added.
Returns
Type Description
System.Int32

The index of the KPI object in the current collection.

Contains(Kpi)

Determines whether the collection contains specified KPI.

Declaration
public bool Contains(Kpi kpi)
Parameters
Type Name Description
Kpi kpi

The KPI object which is to be searched.
Returns
Type Description
System.Boolean

true if it contains the specified KPI; otherwise, false.

CopyTo(Kpi[], Int32)

Copies all the elements of the current collection to the specified one-dimensional array.

Declaration
public void CopyTo(Kpi[] kpiArray, int index)
Parameters
Type Name Description
Kpi[] kpiArray

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 KPI by its name

Declaration
public Kpi FindByName(string name)
Parameters
Type Name Description
System.String name

The name of the KPI.
Returns
Type Description
Kpi

The KPI object.

FindByUniqueName(String)

Finds the KPI by its unique name

Declaration
public Kpi FindByUniqueName(string uniqueName)
Parameters
Type Name Description
System.String uniqueName

The unique name of the KPI.
Returns
Type Description
Kpi

The KPI object.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public IEnumerator<Kpi> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<Kpi>

A System.Collections.Generic.IEnumerator<T> that can be used to iterate through the collection.

IndexOf(Kpi)

Gets the index of the specified KPI.

Declaration
public int IndexOf(Kpi kpi)
Parameters
Type Name Description
Kpi kpi

The KPI.
Returns
Type Description
System.Int32

The index of the KPI in the collection.

Insert(Int32, Kpi)

Inserts the KPI at specified index.

Declaration
public void Insert(int index, Kpi kpi)
Parameters
Type Name Description
System.Int32 index

The index at which the KPI has to be inserted.
Kpi kpi

The KPI 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 value.
System.Object value

The new value of the element at index.
Overrides
System.Collections.CollectionBase.OnInsertComplete(System.Int32, System.Object)

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 oldValue can be found.
System.Object oldValue

The value to replace with newValue.
System.Object newValue

The new value of the element at index.
Overrides
System.Collections.CollectionBase.OnSetComplete(System.Int32, System.Object, System.Object)

Remove(Kpi)

Removes the specified KPI.

Declaration
public void Remove(Kpi kpi)
Parameters
Type Name Description
Kpi kpi

The KPI 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 overridable.

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

index is less than zero. -or- index is equal to or greater than System.Collections.CollectionBase.Count.

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods