Kpi Class

Article
04/26/2013

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 identifier of the measure group that is associated with the calculations in a Kpi.
	Container	(Inherited from Component.)
	CurrentTimeMember	Gets or sets an MDX expression that returns the member that identifies the temporal context of the KPI.
	Description	Gets or sets the description of the component. (Inherited from NamedComponent.)
	DisplayFolder	Gets or sets the folder in which the KPI will appear when a user is browsing the cube.
	FriendlyName	Returns a user-friendly name. (Inherited from NamedComponent.)
	Goal	Gets or sets an MDX numeric expression or a calculation that returns the target value of the KPI.
	ID	Gets or sets the identifier of the component. (Inherited from NamedComponent.)
	KeyForCollection	Returns the key used in collections. (Inherited from NamedComponent.)
	Name	Gets or sets the name of the component. (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	Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
	SiteID	Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
	Status	Gets or sets an MDX expression that represents the state of the KPI at a specified point in time.
	StatusGraphic	Gets or sets a visual element that provides a quick indication of the status for a KPI.
	Translations	Gets the collection of translations associated with a Kpi object.
	Trend	Gets or sets an MDX expression that evaluates the value of the KPI over time.
	TrendGraphic	Gets or sets a visual element that provides a quick indication of the trend for a KPI.
	Value	Gets or sets an MDX numeric expression that returns the actual value of the KPI.
	Weight	Gets or sets an MDX numeric expression that assigns a relative importance to a KPI.

Top

Methods

	Name	Description
	AddToContainer	Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
	AfterInsert	Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
	AfterMove	Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
	AfterRemove	Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
	BeforeRemove	Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
	Clone	Creates a new, full copy of the Kpi object.
	CopyTo	Copies a Kpi to the specified object.
	CreateObjRef	Security Critical. (Inherited from MarshalByRefObject.)
	Dispose	(Inherited from Component.)
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	GetType	(Inherited from Object.)
	InitializeLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	RemoveFromContainer	Infrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
	Submit()	Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
	Submit(Boolean)	Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
	ToString	Returns a string containing the name of the component. (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)	Validates the Kpi object for errors. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone	Creates a new, full copy of the Kpi object.
	IFormattable.ToString	Formats the value of the current instance using the specified format. (Inherited from NamedComponent.)
	IHostableComponent.Host	Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
	IModelComponent.FriendlyPath	Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
	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.

Share via