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 | |
|---|---|---|
.gif "Public property") |
Count | Gets the number of ModelComponent objects in the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
IsFixedSize | Gets a value indicating whether the ModelComponentCollection has a fixed size. (Inherited from ModelComponentCollection.) |
|
IsReadOnly | Gets a value indicating whether the ModelComponentCollection is read-only. (Inherited from ModelComponentCollection.) |
|
IsSynchronized | Gets a value indicating whether access to the ModelComponentCollection is synchronized (thread-safe). (Inherited from ModelComponentCollection.) |
|
Item[Int32] | Gets the Kpi at the specified index from the collection. |
|
Item[String] | Gets the Kpi, with the specified identifier, from the collection. |
|
Parent | Gets the IModelComponent that contains the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
SyncRoot | Gets an object that can be used to synchronize access to the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Add() | Creates and adds a Kpi to the end of the collection. |
|
Add(String) | Creates and adds a Kpi, with the specified identifier, to the end of the collection. |
|
Add(Kpi) | Adds a Kpi to the end of the collection. |
.gif "Protected method") |
Add(ModelComponent) | Infrastructure. Adds a ModelComponent object to the NamedComponentCollection. (Inherited from NamedComponentCollection.) |
|
Add(String, String) | Creates and adds a Kpi, with the specified name and identifier, to the end of the collection. |
|
Add(ModelComponent, Boolean) | Infrastructure. Adds a ModelComponent object to the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
CanAdd | Infrastructure. Indicates whether the collection can add a ModelComponent. (Inherited from NamedComponentCollection.) |
|
ChangeKey | Infrastructure. Changes the specified keys to the collection. (Inherited from ModelComponentCollection.) |
|
Clear | Removes all elements from the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
Contains(String) | Indicates whether the collection contains a Kpi, with the specified identifier. |
|
Contains(Kpi) | Indicates whether the collection contains a specified Kpi. |
|
ContainsName | Indicates whether the component contains its name. (Inherited from NamedComponentCollection.) |
|
CopyTo | Copies the entire ModelComponentCollection to a one-dimensional Array, starting at the specified index of the target array. (Inherited from ModelComponentCollection.) |
|
Equals | (Inherited from Object.) |
|
Find | Gets the Kpi, with the specified identifier, from the collection. |
|
FindByName | Gets the Kpi, with the specified name, from the collection. |
|
GetByName | Gets the Kpi, with the specified name, from the collection. |
|
GetEnumerator | Returns an enumerator that can iterate through the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
GetHashCode | (Inherited from Object.) |
|
GetNewID() | Gets a new unique ID for the component. (Inherited from NamedComponentCollection.) |
|
GetNewID(String) | Gets the value for the new unique ID. (Inherited from NamedComponentCollection.) |
|
GetNewName() | Gets a unique new name for the component. (Inherited from NamedComponentCollection.) |
|
GetNewName(String) | Gets a unique new name for the component with the specified name prefix. (Inherited from NamedComponentCollection.) |
|
GetType | (Inherited from Object.) |
|
IndexOf(String) | Gets the index of a Kpi, with the specified identifier. |
|
IndexOf(Kpi) | Gets the index of a specified Kpi. |
|
IndexOfName | Gets the index of the NamedComponent, identified by name, in the collection. (Inherited from NamedComponentCollection.) |
|
Insert(Int32) | Creates and inserts a Kpi into the collection at the specified index. |
|
Insert(Int32, Kpi) | Inserts a Kpi into the collection at the specified index. |
|
Insert(Int32, String) | Creates and inserts a Kpi, with the specified identifier, into the collection at the specified index. |
|
Insert(Int32, ModelComponent) | Infrastructure. Inserts a ModelComponent in the NamedComponentCollection. (Inherited from NamedComponentCollection.) |
|
Insert(Int32, String, String) | Creates and inserts a Kpi, with the specified name and identifier, into the collection at the specified index. |
|
IsValidID(String) | Determines whether the named component collection identifier is valid. (Inherited from NamedComponentCollection.) |
|
IsValidID(String, String%) | Determines whether the named component collection identifier is valid. (Inherited from NamedComponentCollection.) |
|
IsValidName(String) | Determines whether the named component collection name is valid. (Inherited from NamedComponentCollection.) |
|
IsValidName(String, String%) | Determines whether the named component collection name is valid. (Inherited from NamedComponentCollection.) |
|
IsValidName(String, Type, ModelType, Int32, String%) | (Inherited from NamedComponentCollection.) |
|
Move(Int32, Int32) | Moves a Kpi, at the current specified index, to a new specified index in the collection. |
|
Move(String, Int32) | Moves a Kpi, with the specified identifier, to the specified index in the collection. |
|
Move(Kpi, Int32) | Moves a Kpi to a new index in the collection. |
|
Remove(String) | Removes the Kpi, with the specified identifier, from the collection. |
|
Remove(IModelComponent) | Removes the specified IModelComponent from the collection. (Inherited from ModelComponentCollection.) |
|
Remove(Kpi) | Removes the specified Kpi from the collection. |
|
Remove(String, Boolean) | Infrastructure. Removes the Kpi, with the specified identifier, from the collection. |
|
Remove(Kpi, Boolean) | Infrastructure. Removes the specified KpiCollection from this collection. |
|
RemoveAt(Int32) | Removes the IModelComponent at the specified index from the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
RemoveAt(Int32, Boolean) | Infrastructure. Removes the IModelComponent at the specified index from the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
ToString | (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
CollectionChanged | Infrastructure. Occurs when the collection changes. (Inherited from ModelComponentCollection.) |
|
CollectionChanging | Infrastructure. Occurs when the collection is changing. (Inherited from ModelComponentCollection.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IList.Add | Adds an item to the collection. (Inherited from ModelComponentCollection.) |
|
IList.Clear | Removes all items from the collection. (Inherited from ModelComponentCollection.) |
|
IList.Contains | Indicates whether the collection contains a specific value. (Inherited from ModelComponentCollection.) |
|
IList.IndexOf | Determines the index of a specific item in the collection. (Inherited from ModelComponentCollection.) |
|
IList.Insert | Inserts an item to the collection at the specified index. (Inherited from ModelComponentCollection.) |
.gif "Private property") |
IList.Item | Gets or sets the element at the specified index. (Inherited from ModelComponentCollection.) |
|
IList.Remove | Removes the first occurrence of a specified object from the collection. (Inherited from ModelComponentCollection.) |
|
IList.RemoveAt | Removes the item at the specified index. (Inherited from ModelComponentCollection.) |
|
IModelComponentCollection.Contains | Indicates whether the collection contains a specific value. (Inherited from ModelComponentCollection.) |
|
IModelComponentCollection.Remove(IModelComponent) | Removes the first occurrence of a specific IModelComponent from the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
IModelComponentCollection.Remove(IModelComponent, Boolean) | Removes the first occurrence of a specific IModelComponent from the ModelComponentCollection. (Inherited from ModelComponentCollection.) |
|
IOnDemandLoadableCollection.BlockOnDemandLoad | Specifies the blocked demand load. (Inherited from ModelComponentCollection.) |
|
IOnDemandLoadableCollection.Loaded | Gets or sets a value that indicates whether the collection is 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.