Kpi Class

Reference

Definition

Namespace:: Microsoft.AnalysisServices

Assembly:: Microsoft.AnalysisServices.dll

Package:: Microsoft.AnalysisServices v19.87.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

[System.Runtime.InteropServices.Guid("8627F50A-070E-4501-86E0-1BB6CA124473")]
public sealed class Kpi : Microsoft.AnalysisServices.NamedComponent, ICloneable

[<System.Runtime.InteropServices.Guid("8627F50A-070E-4501-86E0-1BB6CA124473")>]
type Kpi = class
    inherit NamedComponent
    interface ICloneable

Public NotInheritable Class Kpi
Inherits NamedComponent
Implements ICloneable

Inheritance: Component

ModelComponent

NamedComponent
Kpi

Attributes: GuidAttribute

Implements: ICloneable

Constructors

Kpi()	Initializes a new instance of Kpi using the default values.
Kpi(String, String)	Initializes a new instance of Kpi using the specified name and identifier.

Fields

MaxIDLength	Specifies the maximum length of the identifier. (Inherited from NamedComponent)
MaxNameLength	Specifies the maximum length of the name. (Inherited from NamedComponent)

Properties

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 measure group that is associated with the calculations in a Kpi.
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	Gets a user-friendly name for the component. (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	Gets 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 parent Cube object of the Kpi object.
ParentDatabase	Gets the parent Database object of the Kpi object.
ParentKpiID	Gets or sets the parent kpi.
ParentServer	Gets the parent Server object of the Kpi object.
Site	Gets or sets the site associated with the component. (Inherited from NamedComponent)
SiteID	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.

Methods

AddToContainer(IContainer)	Adds the ModelComponent object to the specified container. (Inherited from ModelComponent)
AfterInsert(Int32)	Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent)
AfterMove(Int32, Int32)	Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent)
AfterRemove(ModelComponentCollection)	Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent)
BeforeRemove(Boolean)	Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent)
Clone()	Returns a clone of the object.
CopyTo(Kpi)	Copies the content of this object to another object (the destination).
CopyTo(ModelComponent)	Copies a ModelComponent object to the specified object. (Inherited from ModelComponent)
CopyTo(NamedComponent)	Copies a NamedComponent object to the specified object. (Inherited from NamedComponent)
RemoveFromContainer(IContainer)	Removes the ModelComponent object from the specified container. (Inherited from ModelComponent)
Reset()	Resets the component to its initial state. (Inherited from NamedComponent)
Submit()	Submits a ModelComponent object. (Inherited from ModelComponent)
Submit(Boolean)	Submits a ModelComponent object. (Inherited from ModelComponent)
ToString()	Returns a string representing the named-component. (Inherited from NamedComponent)
Validate(ValidationErrorCollection, Boolean, ServerEdition)	Validates the Kpi object for errors.
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)	Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent)

Explicit Interface Implementations

ICloneable.Clone()
IFormattable.ToString(String, IFormatProvider)	(Inherited from NamedComponent)
IHostableComponent.Host	(Inherited from ModelComponent)
IModelComponent.FriendlyPath	(Inherited from ModelComponent)
IModelComponent.OwningCollection	(Inherited from ModelComponent)

Applies to

Jaa