Article
05/23/2011

Kpi Class

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
	Kpi()	Initializes a new instance of Kpi using the default values.
	Kpi(String, String)	Initializes a new instance of Kpi using a name and an identifier.

Top

Properties

	Name	Description
	Annotations	Gets a collection within which you can store custom data. (Inherited from ModelComponent.)
	AssociatedMeasureGroup	Gets the measure group that is associated with the calculations in a Kpi.
	AssociatedMeasureGroupID	Gets or sets the ID of the measure group that is associated with the calculations in a Kpi.
	CanRaiseEvents	(Inherited from Component.)
	Container	(Inherited from Component.)
	CurrentTimeMember	Gets or sets the CurrentTimeMember of a Kpi.
	Description	(Inherited from NamedComponent.)
	DesignMode	(Inherited from Component.)
	DisplayFolder	Gets or sets the display folder associated with a Kpi object.
	Events	(Inherited from Component.)
	FriendlyName	(Inherited from NamedComponent.)
	Goal	Gets or sets the Goal of a Kpi.
	ID	(Inherited from NamedComponent.)
	KeyForCollection	(Inherited from NamedComponent.)
	Name	(Inherited from NamedComponent.)
	OwningCollection	Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
	Parent	Gets the Cube object that is the parent of the Kpi object.
	ParentDatabase	Gets the Database object that is the parent of the Kpi object's Cube object.
	ParentKpiID	Gets or sets the ID of the parent Kpi.
	ParentServer	Gets the Server object that is the parent of the Kpi.
	Site	(Inherited from NamedComponent.)
	SiteID	(Inherited from NamedComponent.)
	Status	Gets or sets the status for a Kpi object in the form of an MDX expression.
	StatusGraphic	Gets or sets the status graphic associated with a Kpi object.
	Translations	Gets the collection of translations associated with a Kpi object.
	Trend	Gets or sets the trend; which is represented by an MDX expression.
	TrendGraphic	Gets or sets the trend graphic associated with a Kpi object.
	Value	Gets or sets a value for a Kpi object, in the form of an MDX expression.
	Weight	Gets or sets the weight value associated with a Kpi object.

Top

Methods

	Name	Description
	AddToContainer	Infrastructure. (Inherited from ModelComponent.)
	AfterInsert	Infrastructure. (Inherited from ModelComponent.)
	AfterMove	Infrastructure. (Inherited from ModelComponent.)
	AfterRemove	Infrastructure. (Inherited from ModelComponent.)
	BeforeRemove	Infrastructure. (Inherited from ModelComponent.)
	Clone	Creates a new, full copy of an object.
	CopyTo(Kpi)	Copies a Kpi to the specified object.
	CopyTo(ModelComponent)	Infrastructure. (Inherited from ModelComponent.)
	CopyTo(NamedComponent)	(Inherited from NamedComponent.)
	CreateObjRef	(Inherited from MarshalByRefObject.)
	Dispose()	(Inherited from Component.)
	Dispose(Boolean)	(Inherited from Component.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Component.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	(Inherited from MarshalByRefObject.)
	GetService	(Inherited from Component.)
	GetType	(Inherited from Object.)
	InitializeLifetimeService	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	RemoveFromContainer	Infrastructure. (Inherited from ModelComponent.)
	Reset	(Inherited from NamedComponent.)
	Submit()	Infrastructure. (Inherited from ModelComponent.)
	Submit(Boolean)	Infrastructure. (Inherited from ModelComponent.)
	ToString	(Inherited from NamedComponent.)
	Validate(ValidationErrorCollection)	Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
	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.)
	Validate(ValidationErrorCollection, Boolean, ServerEdition)	(Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone
	IFormattable.ToString	(Inherited from NamedComponent.)
	IHostableComponent.Host	(Inherited from ModelComponent.)
	IModelComponent.FriendlyPath	(Inherited from ModelComponent.)
	IModelComponent.OwningCollection	(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.