Kpi Kpi Kpi Class

Definition

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

public ref class Kpi sealed : Microsoft::AnalysisServices::NamedComponent, ICloneable
[System.Runtime.InteropServices.Guid("8627F50A-070E-4501-86E0-1BB6CA124473")]
public sealed class Kpi : Microsoft.AnalysisServices.NamedComponent, ICloneable
Public NotInheritable Class Kpi
Inherits NamedComponent
Implements ICloneable
Inheritance
Attributes
Implements

Constructors

Kpi() Kpi() Kpi()

Initializes a new instance of Kpi using the default values.

Kpi(String, String) Kpi(String, String) Kpi(String, String)

Initializes a new instance of Kpi using a name and an identifier.

Properties

Annotations Annotations Annotations

Gets a collection within which you can store custom data.

(Inherited from ModelComponent)
AssociatedMeasureGroup AssociatedMeasureGroup AssociatedMeasureGroup

Gets the measure group that is associated with the calculations in a Kpi.

AssociatedMeasureGroupID AssociatedMeasureGroupID AssociatedMeasureGroupID

Gets or sets the identifier of the measure group that is associated with the calculations in a Kpi.

CurrentTimeMember CurrentTimeMember CurrentTimeMember

Gets or sets an MDX expression that returns the member that identifies the temporal context of the KPI.

Description Description Description

Gets or sets the description of the component.

(Inherited from NamedComponent)
DisplayFolder DisplayFolder DisplayFolder

Gets or sets the folder in which the KPI will appear when a user is browsing the cube.

FriendlyName FriendlyName FriendlyName

Returns a user-friendly name.

(Inherited from NamedComponent)
Goal Goal Goal

Gets or sets an MDX numeric expression or a calculation that returns the target value of the KPI.

ID ID ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
IHostableComponent.Host IHostableComponent.Host IHostableComponent.Host

Gets or sets the IServiceProvider that is the host of the ModelComponent.

(Inherited from ModelComponent)
IModelComponent.FriendlyPath IModelComponent.FriendlyPath IModelComponent.FriendlyPath

Gets a friendly path for the ModelComponent.

(Inherited from ModelComponent)
IModelComponent.OwningCollection IModelComponent.OwningCollection IModelComponent.OwningCollection

Gets or sets the collection that owns the current object.

(Inherited from ModelComponent)
KeyForCollection KeyForCollection KeyForCollection

Returns the key used in collections.

(Inherited from NamedComponent)
Name Name Name

Gets or sets the name of the component.

(Inherited from NamedComponent)
OwningCollection OwningCollection OwningCollection

Gets or sets the collection that contains the ModelComponent.

(Inherited from ModelComponent)
Parent Parent Parent

Gets the Cube object that is the parent of the Kpi object.

ParentDatabase ParentDatabase ParentDatabase

Gets the Database object that is the parent of the Kpi object's Cube object.

ParentKpiID ParentKpiID ParentKpiID

Gets or sets the ID of the parent Kpi.

ParentServer ParentServer ParentServer

Gets the Server object that is the parent of the Kpi.

Site Site Site

Gets or sets the site of the component.

(Inherited from NamedComponent)
SiteID SiteID SiteID

Gets or sets the identifier for the site associated with the component.

(Inherited from NamedComponent)
Status Status Status

Gets or sets an MDX expression that represents the state of the KPI at a specified point in time.

StatusGraphic StatusGraphic StatusGraphic

Gets or sets a visual element that provides a quick indication of the status for a KPI.

Translations Translations Translations

Gets the collection of translations associated with a Kpi object.

Trend Trend Trend

Gets or sets an MDX expression that evaluates the value of the KPI over time.

TrendGraphic TrendGraphic TrendGraphic

Gets or sets a visual element that provides a quick indication of the trend for a KPI.

Value Value Value

Gets or sets an MDX numeric expression that returns the actual value of the KPI.

Weight Weight Weight

Gets or sets an MDX numeric expression that assigns a relative importance to a KPI.

Methods

AddToContainer(IContainer) AddToContainer(IContainer) AddToContainer(IContainer)

Adds a ModelComponent object to the specified container.

(Inherited from ModelComponent)
AfterInsert(Int32) AfterInsert(Int32) AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.

(Inherited from ModelComponent)
AfterMove(Int32, Int32) AfterMove(Int32, Int32) AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.

(Inherited from ModelComponent)
AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.

(Inherited from ModelComponent)
BeforeRemove(Boolean) BeforeRemove(Boolean) BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.

(Inherited from ModelComponent)
Clone() Clone() Clone()

Creates a new, full copy of the Kpi object.

CopyTo(Kpi) CopyTo(Kpi) CopyTo(Kpi)

Copies a Kpi to the specified object.

CopyTo(ModelComponent) CopyTo(ModelComponent) CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.

(Inherited from ModelComponent)
CopyTo(NamedComponent) CopyTo(NamedComponent) CopyTo(NamedComponent)

Copies a NamedComponent object to the specified object.

(Inherited from NamedComponent)
RemoveFromContainer(IContainer) RemoveFromContainer(IContainer) RemoveFromContainer(IContainer)

Removes a ModelComponent object from the specified container.

(Inherited from ModelComponent)
Reset() Reset() Reset()

Resets the component to its initial state.

(Inherited from NamedComponent)
Submit() Submit() Submit()

Submits a ModelComponent object.

(Inherited from ModelComponent)
Submit(Boolean) Submit(Boolean) Submit(Boolean)

Submits a ModelComponent object.

(Inherited from ModelComponent)
ToString() ToString() ToString()

Returns a string containing the name of the component.

(Inherited from NamedComponent)
Validate(ValidationErrorCollection) Validate(ValidationErrorCollection) Validate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.

(Inherited from ModelComponent)
Validate(ValidationErrorCollection, Boolean) Validate(ValidationErrorCollection, Boolean) 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) Validate(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition)

Validates the Kpi object for errors.

Explicit Interface Implementations

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()

Creates a new, full copy of the Kpi object.

IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.

(Inherited from NamedComponent)

Fields

MaxIDLength MaxIDLength MaxIDLength

Specifies the maximum length of the identifier.

(Inherited from NamedComponent)
MaxNameLength MaxNameLength MaxNameLength

Specifies the maximum length of the name.

(Inherited from NamedComponent)

Applies to