Kpi Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

OLAP KPI.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is x:kpi.

public class Kpi : DocumentFormat.OpenXml.OpenXmlLeafElement

type Kpi = class
    inherit OpenXmlLeafElement

Public Class Kpi
Inherits OpenXmlLeafElement

Inheritance

Object

OpenXmlElement

OpenXmlLeafElement

Kpi

Remarks

[ISO/IEC 29500-1 1st Edition]

kpi (OLAP KPI)

Represents the KPI defined on the OLAP server and stored in the PivotCache.

[Example:

<kpi uniqueName="Growth in Customer Base" caption="Growth in Customer Base"  displayFolder="Customer Perspective\Expand Customer Base"   measureGroup="Internet Sales" value="[Measures].[Growth in Customer Base]"   goal="[Measures].[Growth in Customer Base Goal]"   status="[Measures].[Growth in Customer Base Status]"   trend="[Measures].[Growth in Customer Base Trend]"/>  

end example]

Parent Elements
kpis (§18.10.1.48)

Attributes	Description
caption (KPI Display Name)	Specifies the display name of the KPI. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
displayFolder (KPI Display Folder)	Specifies the folder where this KPI is displayed in a list of fields for the PivotTable. This attribute depends on how the application exposes a list of fields in the user interface. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
goal (KPI Goal Unique Name)	Specifies the unique name of the KPI goal measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
measureGroup (KPI Measure Group Name)	Specifies the name of the measure group to which this KPI belongs. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
parent (Parent KPI)	Specifies the name of the parent KPI for this KPI. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
status (KPI Status Unique Name)	Specifies the unique name of the KPI status measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
time (Time Member KPI Unique Name)	Specifies the unique name of the KPI current time member. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
trend (KPI Trend Unique Name)	Specifies the unique name of the KPI trend measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
uniqueName (KPI Unique Name)	Specifies the unique name of the KPI. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
value (KPI Value Unique Name)	Specifies the unique name of the KPI value measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
weight (KPI Weight Unique Name)	Specifies the unique name of the KPI weight measure. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

[Note: The W3C XML Schema definition of this element’s content model (CT_PCDKPI) is located in §A.2. end note]

� ISO/IEC29500: 2008.

Constructors

Kpi()

Initializes a new instance of the Kpi class.

Properties

Caption	KPI Display Name Represents the following attribute in the schema: caption
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
DisplayFolder	KPI Display Folder Represents the following attribute in the schema: displayFolder
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
Goal	KPI Goal Unique Name Represents the following attribute in the schema: goal
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlLeafElement)
InnerText	Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement)
InnerXml	Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement)
LastChild	Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
MeasureGroup	KPI Measure Group Name Represents the following attribute in the schema: measureGroup
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
ParentKpi	Parent KPI Represents the following attribute in the schema: parent
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Status	KPI Status Unique Name Represents the following attribute in the schema: status
Trend	KPI Trend Unique Name Represents the following attribute in the schema: trend
UniqueName	KPI Unique Name Represents the following attribute in the schema: uniqueName
Value	KPI Value Unique Name Represents the following attribute in the schema: value
Weight	KPI Weight Unique Name Represents the following attribute in the schema: weight
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index in the current element's list of child elements. (Inherited from OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child elements. (Inherited from OpenXmlElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all child elements of the current element. (Inherited from OpenXmlLeafElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element from the current element's list of child elements. (Inherited from OpenXmlElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)