Kpi Class

  • Article

Represents a Key Performance Indicator (KPI). This class cannot be inherited.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.AnalysisServices.ModelComponent
        Microsoft.AnalysisServices.NamedComponent
          Microsoft.AnalysisServices.Kpi

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

Syntax

'Declaration
<GuidAttribute("8627F50A-070E-4501-86E0-1BB6CA124473")> _
Public NotInheritable Class Kpi _
    Inherits NamedComponent _
    Implements ICloneable
'Usage
Dim instance As Kpi

[GuidAttribute("8627F50A-070E-4501-86E0-1BB6CA124473")]
public sealed class Kpi : NamedComponent, ICloneable

[GuidAttribute(L"8627F50A-070E-4501-86E0-1BB6CA124473")]
public ref class Kpi sealed : public NamedComponent, 
    ICloneable

[<SealedAttribute>]
[<GuidAttribute("8627F50A-070E-4501-86E0-1BB6CA124473")>]
type Kpi =  
    class 
        inherit NamedComponent 
        interface ICloneable 
    end

public final class Kpi extends NamedComponent implements ICloneable

The Kpi type exposes the following members.

Constructors

  Name Description
Public method Kpi() Initializes a new instance of Kpi using the default values.
Public method Kpi(String, String) Initializes a new instance of Kpi using a name and an identifier.

Top

Properties

  Name Description
Public property Annotations Gets a collection within which you can store custom data. (Inherited from ModelComponent.)
Public property AssociatedMeasureGroup Gets the measure group that is associated with the calculations in a Kpi.
Public property AssociatedMeasureGroupID Gets or sets the identifier of the measure group that is associated with the calculations in a Kpi.
Public property Container (Inherited from Component.)
Public property CurrentTimeMember Gets or sets an MDX expression that returns the member that identifies the temporal context of the KPI.
Public property Description Gets or sets the description of the component. (Inherited from NamedComponent.)
Public property DisplayFolder Gets or sets the folder in which the KPI will appear when a user is browsing the cube.
Protected property FriendlyName Returns a user-friendly name. (Inherited from NamedComponent.)
Public property Goal Gets or sets an MDX numeric expression or a calculation that returns the target value of the KPI.
Public property ID Gets or sets the identifier of the component. (Inherited from NamedComponent.)
Protected property KeyForCollection Returns the key used in collections. (Inherited from NamedComponent.)
Public property Name Gets or sets the name of the component. (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Gets the Cube object that is the parent of the Kpi object.
Public property ParentDatabase Gets the Database object that is the parent of the Kpi object's Cube object.
Public property ParentKpiID Gets or sets the ID of the parent Kpi.
Public property ParentServer Gets the Server object that is the parent of the Kpi.
Public property Site Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public property SiteID Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
Public property Status Gets or sets an MDX expression that represents the state of the KPI at a specified point in time.
Public property StatusGraphic Gets or sets a visual element that provides a quick indication of the status for a KPI.
Public property Translations Gets the collection of translations associated with a Kpi object.
Public property Trend Gets or sets an MDX expression that evaluates the value of the KPI over time.
Public property TrendGraphic Gets or sets a visual element that provides a quick indication of the trend for a KPI.
Public property Value Gets or sets an MDX numeric expression that returns the actual value of the KPI.
Public property Weight Gets or sets an MDX numeric expression that assigns a relative importance to a KPI.

Top

Methods

  Name Description
Protected method AddToContainer Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
Protected method BeforeRemove Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
Public method Clone Creates a new, full copy of the Kpi object.
Public method CopyTo Copies a Kpi to the specified object.
Public method CreateObjRef Security Critical. (Inherited from MarshalByRefObject.)
Public method Dispose (Inherited from Component.)
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService Security Critical. (Inherited from MarshalByRefObject.)
Public method GetType (Inherited from Object.)
Public method InitializeLifetimeService Security Critical. (Inherited from MarshalByRefObject.)
Protected method RemoveFromContainer Infrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public method Submit() Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public method ToString Returns a string containing the name of the component. (Inherited from NamedComponent.)
Public method Validate(ValidationErrorCollection) Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public method Validate(ValidationErrorCollection, Boolean) Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors. (Inherited from ModelComponent.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) Validates the Kpi object for errors. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICloneable.Clone Creates a new, full copy of the Kpi object.
Explicit interface implemetationPrivate method IFormattable.ToString Formats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate property IHostableComponent.Host Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IModelComponent.FriendlyPath Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IModelComponent.OwningCollection Gets or sets the collection that owns the current object. (Inherited from ModelComponent.)

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.

See Also

Reference

Microsoft.AnalysisServices Namespace