Share via

KpiCollection Class

Contains a collection of Kpi objects. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.ModelComponentCollection
    Microsoft.AnalysisServices.NamedComponentCollection
      Microsoft.AnalysisServices.KpiCollection

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

Syntax

'Declaration
<GuidAttribute("CA8FC5AC-EFE3-4b62-958A-15C0DF4857AB")> _
Public NotInheritable Class KpiCollection _
    Inherits NamedComponentCollection
'Usage
Dim instance As KpiCollection

[GuidAttribute("CA8FC5AC-EFE3-4b62-958A-15C0DF4857AB")]
public sealed class KpiCollection : NamedComponentCollection

[GuidAttribute(L"CA8FC5AC-EFE3-4b62-958A-15C0DF4857AB")]
public ref class KpiCollection sealed : public NamedComponentCollection

[<SealedAttribute>]
[<GuidAttribute("CA8FC5AC-EFE3-4b62-958A-15C0DF4857AB")>]
type KpiCollection =  
    class
        inherit NamedComponentCollection
    end

public final class KpiCollection extends NamedComponentCollection

The KpiCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of ModelComponent objects in the ModelComponentCollection. (Inherited from ModelComponentCollection.)
Protected property DemandLoadingService Infrastructure. (Inherited from ModelComponentCollection.)
Public property IsFixedSize Gets a value indicating whether the ModelComponentCollection has a fixed size. (Inherited from ModelComponentCollection.)
Public property IsReadOnly Gets a value indicating whether the ModelComponentCollection is read-only. (Inherited from ModelComponentCollection.)
Public property IsSynchronized Gets a value indicating whether access to the ModelComponentCollection is synchronized (thread-safe). (Inherited from ModelComponentCollection.)
Public property Item[Int32] Gets the Kpi at the specified index from the collection.
Public property Item[String] Gets the Kpi, with the specified identifier, from the collection.
Protected property ItemsType Gets the Type of objects that can be contained by the ModelComponentCollection. (Inherited from ModelComponentCollection.)
Public property Parent Gets the IModelComponent that contains the ModelComponentCollection. (Inherited from ModelComponentCollection.)
Protected property Preloadable Infrastructure. (Inherited from ModelComponentCollection.)
Public property SyncRoot Gets an object that can be used to synchronize access to the ModelComponentCollection. (Inherited from ModelComponentCollection.)

Top

Methods

  Name Description
Public method Add() Creates and adds a Kpi to the end of the collection.
Public method Add(String) Creates and adds a Kpi, with the specified identifier, to the end of the collection.
Public method Add(Kpi) Adds a Kpi to the end of the collection.
Protected method Add(ModelComponent) Infrastructure. (Inherited from NamedComponentCollection.)
Public method Add(String, String) Creates and adds a Kpi, with the specified name and identifier, to the end of the collection.
Protected method Add(String, IModelComponent) (Inherited from ModelComponentCollection.)
Protected method Add(ModelComponent, Boolean) Infrastructure. (Inherited from ModelComponentCollection.)
Protected method Add(String, IModelComponent, Boolean) (Inherited from ModelComponentCollection.)
Protected method AddNew(String, Type) Infrastructure. (Inherited from ModelComponentCollection.)
Protected method AddNew(String, String, Type) Infrastructure. (Inherited from ModelComponentCollection.)
Public method CanAdd Infrastructure. (Inherited from NamedComponentCollection.)
Protected method ChangeKey Infrastructure. (Inherited from ModelComponentCollection.)
Public method Clear Removes all elements from the ModelComponentCollection. (Inherited from ModelComponentCollection.)
Public method Contains(String) Indicates whether the collection contains a Kpi, with the specified identifier.
Protected method Contains(IModelComponent) (Inherited from ModelComponentCollection.)
Public method Contains(Kpi) Indicates whether the collection contains a specified Kpi.
Public method ContainsName (Inherited from NamedComponentCollection.)
Public method CopyTo Copies the entire ModelComponentCollection to a one-dimensional Array, starting at the specified index of the target array. (Inherited from ModelComponentCollection.)
Protected method EnsureLoaded Infrastructure. (Inherited from ModelComponentCollection.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method Find Gets the Kpi, with the specified identifier, from the collection.
Public method FindByName Gets the Kpi, with the specified name, from the collection.
Public method GetByName Gets the Kpi, with the specified name, from the collection.
Public method GetEnumerator Returns an enumerator that can iterate through the ModelComponentCollection. (Inherited from ModelComponentCollection.)
Public method GetHashCode (Inherited from Object.)
Protected method GetItem Gets a reference to the specified component. (Inherited from ModelComponentCollection.)
Public method GetNewID() (Inherited from NamedComponentCollection.)
Public method GetNewID(String) (Inherited from NamedComponentCollection.)
Public method GetNewName() (Inherited from NamedComponentCollection.)
Public method GetNewName(String) (Inherited from NamedComponentCollection.)
Public method GetType (Inherited from Object.)
Public method IndexOf(String) Gets the index of a Kpi, with the specified identifier.
Protected method IndexOf(IModelComponent) (Inherited from ModelComponentCollection.)
Public method IndexOf(Kpi) Gets the index of a specified Kpi.
Public method IndexOfName (Inherited from NamedComponentCollection.)
Public method Insert(Int32) Creates and inserts a Kpi into the collection at the specified index.
Public method Insert(Int32, Kpi) Inserts a Kpi into the collection at the specified index.
Public method Insert(Int32, String) Creates and inserts a Kpi, with the specified identifier, into the collection at the specified index.
Protected method Insert(Int32, ModelComponent) (Inherited from NamedComponentCollection.)
Public method Insert(Int32, String, String) Creates and inserts a Kpi, with the specified name and identifier, into the collection at the specified index.
Protected method Insert(IModelComponent, String, Int32) (Inherited from ModelComponentCollection.)
Protected method Insert(IModelComponent, String, Int32, Boolean) (Inherited from ModelComponentCollection.)
Public method IsValidID(String) (Inherited from NamedComponentCollection.)
Public method IsValidID(String, String%) (Inherited from NamedComponentCollection.)
Protected method IsValidID(String, Type, String%) (Inherited from NamedComponentCollection.)
Public method IsValidName(String) (Inherited from NamedComponentCollection.)
Public method IsValidName(String, String%) (Inherited from NamedComponentCollection.)
Protected method IsValidName(String, Type, String%) (Inherited from NamedComponentCollection.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Move(Int32, Int32) Moves a Kpi, at the current specified index, to a new specified index in the collection.
Public method Move(String, Int32) Moves a Kpi, with the specified identifier, to the specified index in the collection.
Public method Move(Kpi, Int32) Moves a Kpi to a new index in the collection.
Public method Remove(String) Removes the Kpi, with the specified identifier, from the collection.
Protected method Remove(IModelComponent) (Inherited from ModelComponentCollection.)
Public method Remove(Kpi) Removes the specified Kpi from the collection.
Public method Remove(String, Boolean) Infrastructure.
Public method Remove(Kpi, Boolean) Infrastructure.
Public method RemoveAt(Int32) Removes the IModelComponent at the specified index from the ModelComponentCollection. (Inherited from ModelComponentCollection.)
Public method RemoveAt(Int32, Boolean) Infrastructure. (Inherited from ModelComponentCollection.)
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event CollectionChanged Infrastructure. (Inherited from ModelComponentCollection.)
Public event CollectionChanging Infrastructure. (Inherited from ModelComponentCollection.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IList.Add (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IList.Clear (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IList.Contains (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IList.IndexOf (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IList.Insert (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate property IList.Item (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IList.Remove (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IList.RemoveAt (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IModelComponentCollection.Contains (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IModelComponentCollection.Remove(IModelComponent) (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IModelComponentCollection.Remove(IModelComponent, Boolean) (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate method IOnDemandLoadableCollection.BlockOnDemandLoad (Inherited from ModelComponentCollection.)
Explicit interface implemetationPrivate property IOnDemandLoadableCollection.Loaded (Inherited from ModelComponentCollection.)

Top

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.