Article
05/23/2011

Kpi Class

Key Performance Indicators (KPIs) are metadata wrappers around measures and Multidimensional Expressions (MDX) expressions.

Inheritance Hierarchy

System.Object
Microsoft.AnalysisServices.AdomdClient.Kpi

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

Syntax

'Declaration
Public NotInheritable Class Kpi
'Usage
Dim instance As Kpi

public sealed class Kpi

public ref class Kpi sealed

[<SealedAttribute>]
type Kpi =  class end

public final class Kpi

The Kpi type exposes the following members.

Properties

	Name	Description
	Caption	Gets the caption associated with the Kpi.
	Description	Gets a human-readable description of the Kpi.
	DisplayFolder	Gets a forward-slash-delimited categorization structure, used by client applications to determine the hierarchical presentation of the Kpi.
	Name	Gets the name of the Kpi.
	ParentCube	Gets the CubeDef representing the cube to which the Key Performance Indicator (KPI) belongs.
	ParentKpi	Gets the parent Kpi of the current Kpi.
	Properties	Gets a collection containing the properties of the Kpi.
	StatusGraphic	Gets a String representing a graphic for displaying Kpi status.
	TrendGraphic	Gets a String representing a graphic for displaying Kpi trend information.

Top

Methods

	Name	Description
	Equals	Determines whether two instances of Kpi are equal. (Overrides Object.Equals(Object).)
	Finalize	(Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type, for use in hashing algorithms and data structures such as hash tables. (Overrides Object.GetHashCode().)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	Gets the name of the Kpi. (Overrides Object.ToString().)

Top

Operators

	Name	Description
	Equality	Determines whether two specified instances of Kpi are equal.
	Inequality	Determines whether two specified instances of Kpi are not equal.

Top

Remarks

KPIs provide a framework for categorizing these expressions into a set of pre-defined data roles (actual, goal, trend, status, and others), which allows user interface (UI) developers additional metadata for creating new interfaces.

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.

Share via