Export (0) Print
Expand All

Kpi Class

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

Object
  MarshalByRefObject
    Component
      Microsoft.AnalysisServices.ModelComponent
        Microsoft.AnalysisServices.NamedComponent
          Microsoft.AnalysisServices.Kpi

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

[GuidAttribute("8627F50A-070E-4501-86E0-1BB6CA124473")]
public sealed class Kpi : NamedComponent, ICloneable

The Kpi type exposes the following members.

  NameDescription
Public methodKpi()Initializes a new instance of Kpi using the default values.
Public methodKpi(String, String)Initializes a new instance of Kpi using a name and an identifier.
Top

  NameDescription
Public propertyAnnotationsGets a collection within which you can store custom data. (Inherited from ModelComponent.)
Public propertyAssociatedMeasureGroupGets the measure group that is associated with the calculations in a Kpi.
Public propertyAssociatedMeasureGroupIDGets or sets the identifier of the measure group that is associated with the calculations in a Kpi.
Public propertyContainer (Inherited from Component.)
Public propertyCurrentTimeMemberGets or sets an MDX expression that returns the member that identifies the temporal context of the KPI.
Public propertyDescriptionGets or sets the description of the component. (Inherited from NamedComponent.)
Public propertyDisplayFolderGets or sets the folder in which the KPI will appear when a user is browsing the cube.
Protected propertyFriendlyNameReturns a user-friendly name. (Inherited from NamedComponent.)
Public propertyGoalGets or sets an MDX numeric expression or a calculation that returns the target value of the KPI.
Public propertyIDGets or sets the identifier of the component. (Inherited from NamedComponent.)
Protected propertyKeyForCollectionReturns the key used in collections. (Inherited from NamedComponent.)
Public propertyNameGets or sets the name of the component. (Inherited from NamedComponent.)
Public propertyOwningCollectionGets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public propertyParentGets the Cube object that is the parent of the Kpi object.
Public propertyParentDatabaseGets the Database object that is the parent of the Kpi object's Cube object.
Public propertyParentKpiIDGets or sets the ID of the parent Kpi.
Public propertyParentServerGets the Server object that is the parent of the Kpi.
Public propertySiteInfrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public propertySiteIDInfrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
Public propertyStatusGets or sets an MDX expression that represents the state of the KPI at a specified point in time.
Public propertyStatusGraphicGets or sets a visual element that provides a quick indication of the status for a KPI.
Public propertyTranslationsGets the collection of translations associated with a Kpi object.
Public propertyTrendGets or sets an MDX expression that evaluates the value of the KPI over time.
Public propertyTrendGraphicGets or sets a visual element that provides a quick indication of the trend for a KPI.
Public propertyValueGets or sets an MDX numeric expression that returns the actual value of the KPI.
Public propertyWeightGets or sets an MDX numeric expression that assigns a relative importance to a KPI.
Top

  NameDescription
Protected methodAddToContainerInfrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected methodAfterInsertInfrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected methodAfterMoveInfrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected methodAfterRemoveInfrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
Protected methodBeforeRemoveInfrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
Public methodCloneCreates a new, full copy of the Kpi object.
Public methodCopyToCopies a Kpi to the specified object.
Public methodCreateObjRefSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodDispose (Inherited from Component.)
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Protected methodRemoveFromContainerInfrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public methodSubmit()Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodSubmit(Boolean)Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodToStringReturns a string containing the name of the component. (Inherited from NamedComponent.)
Public methodValidate(ValidationErrorCollection)Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public methodValidate(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.)
Public methodValidate(ValidationErrorCollection, Boolean, ServerEdition)Validates the Kpi object for errors. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Top

  NameDescription
Public eventDisposed (Inherited from Component.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICloneableCloneCreates a new, full copy of the Kpi object.
Explicit interface implemetationPrivate methodIFormattableToStringFormats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate propertyIHostableComponent.HostGets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIModelComponent.FriendlyPathGets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIModelComponent.OwningCollectionGets or sets the collection that owns the current object. (Inherited from ModelComponent.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft