CacheHierarchy Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

PivotCache Hierarchy.

This class is available in Office 2007 and above.

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

public class CacheHierarchy : DocumentFormat.OpenXml.OpenXmlCompositeElement

type CacheHierarchy = class
    inherit OpenXmlCompositeElement

Public Class CacheHierarchy
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

CacheHierarchy

Remarks

[ISO/IEC 29500-1 1st Edition]

cacheHierarchy (PivotCache Hierarchy)

Represents an OLAP hierarchy in the PivotCache.

[Example:

<cacheHierarchy uniqueName="[Account].[Account Number]" caption="Account Number"  attribute="1" defaultMemberUniqueName="[Account].[Account Number].[All   Accounts]" allUniqueName="[Account].[Account Number].[All Accounts]"   dimensionUniqueName="[Account]" count="0"/>  

end example]

Parent Elements
cacheHierarchies (§18.10.1.5)

Child Elements	Subclause
extLst (Future Feature Data Storage Area)	§18.2.10
fieldsUsage (Fields Usage)	§18.10.1.31
groupLevels (OLAP Grouping Levels)	§18.10.1.40

Attributes	Description
allCaption (Display Name of 'All')	Specifies the display name of the "all" member of this hierarchy. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
allUniqueName (Unique Name of 'All')	Specifies the unique name of the "all" member of this hierarchy. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
attribute (Attribute Hierarchy)	Specifies a boolean value that indicates whether this hierarchy is an attribute hierarchy. An attribute hierarchy is an OLAP member that is exposed as a flat, single-level hierarchy on the OLAP server. A value of 1 or true indicates this hierarchy is an attribute hierarchy. A value of 0 or false indicates this hierarchy is not an attribute hierarchy. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
caption (Hierarchy Display Name)	Specifies the display name of the hierarchy. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
count (Levels Count)	Specifies the number of levels in this hierarchy. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
defaultMemberUniqueName (Default Member Unique Name)	Specifies the unique name of the default member of this hierarchy The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
dimensionUniqueName (Dimension Unique Name)	Specifies the unique name of the dimension to which this hierarchy belongs. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
displayFolder (Display Folder)	Specifies the display folder in which this hierarchy should be displayed. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
hidden (Hidden)	Specifies a boolean value that indicates whether the hierarchy is hidden. A value of 1 or true indicates this hierarchy is hidden. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
iconSet (KPI Icon Set)	Specifies the icon set to use to visualize a KPI trend or status expression. PivotTables use the icon sets available for conditional formatting in SpreadsheetML. See associated simple type definition for details. The following values are used by PivotTables: - no value: default iconset. For status KPI this corresponds to 3 traffic lights. For trend KPI this corresponds to 3-arrows. - 1: Variance Arrow - 3 arrow. - 2: 3 arrows - 3: Status Arrow Ascending - 5 arrows. - 4: Status Arrow Descending - 5 arrows - 5: Standard Arrow - 5 arrows gray. - 6: Traffic Light Single - 3 traffic lights 1. - 7: Traffic Light, Traffic Light Multiple - 3 traffic lights 2. - 8: Gauge Ascending - 5 quarters. - 9: Gauge Descending - 5 quarters. - 10: Thermometer, Cylinder, Smiley Face - 3 signs. - 11: Road Signs - 3 symbols. The possible values for this attribute are defined by the W3C XML Schema int datatype.
keyAttribute (Key Attribute Hierarchy)	Specifies a boolean value that indicates whether this hierarchy is the key attribute hierarchy in an OLAP dimension. A value of 1 or true indicates this hierarchy is the key attribute hierarchy in an OLAP dimension. A value of 0 or false indicates this hierarchy is not a key attribute hierarchy. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
measure (Measure Hierarchy)	Specifies a boolean value that indicates whether this hierarchy is a measure. A value of 1 or true indicates this hierarchy is a measure. A value of 0 or false indicates this hierarchy is not a measure. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
measureGroup (Measure Group Name)	Specifies the name of the measure group to which this hierarchy belongs. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
measures (Measures)	Specifies a boolean value that indicates whether this hierarchy contains all the measures. A value of 1 or true indicates this hierarchy contains all the measures. A value of 0 or false indicates this hierarchy does not contain all the measures. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
memberValueDatatype (Member Value Data Type)	Specifies the data type of the member value. This attribute stores an OLEDB data type. [Note: Data connectivity can use a number of different technologies. One example of potential values stored in this attribute can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/oledbtype_indicators.asp end note] memberValueDataType is stored for key attribute hierarchies in order to tell when the application will offer date filtering instead of label filtering in OLAP PivotTables. Date filtering is only offered when the data type is Date/Time. memberValueDatatype="7" indicates a date/time data type. The possible values for this attribute are defined by the W3C XML Schema unsignedShort datatype.
oneField (One Field)	Specifies a boolean value that indicates whether this hierarchy is associated with only one field due to its position in the view. A value of 1 or true indicates this hierarchy is associated with only one field. A value of 0 or false indicates this field is not restricted to only one association due to its position in the user interface. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
parentSet (Parent Set)	Specifies the parent hierarchy of the set. If the attribute is missing it means that the parent hierarchy is unknown or doesn't exist in the cache. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
set (Set)	Specifies a boolean value that indicates whether this hierarchy is a set. A value of 1 or true indicates this hierarchy is a set. A value of 0 or false indicates this hierarchy is not a set. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
time (Time)	Specifies a boolean value that indicates whether this hierarchy is of type time. A value of 1 or true indicates this hierarchy is of type time. A value of 0 or false indicates is of a different type. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
unbalanced (Unbalanced)	Specifies a boolean value that indicates whether this hierarchy is an unbalanced hierarchy. If value is not written, then this attribute either cannot be determined or does not apply to the current hierarchy. A value of 1 or true indicates this hierarchy is unbalanced. A value of 0 or false indicates is balanced. For more information on balanced hierarchies, see the documentation provided for your OLAP server. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
unbalancedGroup (Unbalanced Group)	Specifies a boolean value that indicated whether the grouped version of this hierarchy is an unbalanced hierarchy. If value is not written, then this attribute either cannot be determined or does not apply to the current hierarchy. A value of 1 or true indicates this hierarchy is unbalanced when grouped. A value of 0 or false indicates is balanced when grouped. For more information on balanced hierarchies, see the documentation provided for your OLAP server. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
uniqueName (Hierarchy Unique Name)	Specifies the unique name of the hierarchy. 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_CacheHierarchy) is located in §A.2. end note]

� ISO/IEC29500: 2008.

Constructors

CacheHierarchy()	Initializes a new instance of the CacheHierarchy class.
CacheHierarchy(IEnumerable<OpenXmlElement>)	Initializes a new instance of the CacheHierarchy class with the specified child elements.
CacheHierarchy(OpenXmlElement[])	Initializes a new instance of the CacheHierarchy class with the specified child elements.
CacheHierarchy(String)	Initializes a new instance of the CacheHierarchy class from outer XML.

Properties

AllCaption	allCaption Represents the following attribute in the schema: allCaption
AllUniqueName	allUniqueName Represents the following attribute in the schema: allUniqueName
Attribute	attribute Represents the following attribute in the schema: attribute
CacheHierarchyExtensionList	CacheHierarchyExtensionList. Represents the following element tag in the schema: x:extLst.
Caption	caption Represents the following attribute in the schema: caption
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Count	count Represents the following attribute in the schema: count
DefaultMemberUniqueName	defaultMemberUniqueName Represents the following attribute in the schema: defaultMemberUniqueName
DimensionUniqueName	dimensionUniqueName Represents the following attribute in the schema: dimensionUniqueName
DisplayFolder	displayFolder 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)
FieldsUsage	FieldsUsage. Represents the following element tag in the schema: x:fieldsUsage.
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
GroupLevels	GroupLevels. Represents the following element tag in the schema: x:groupLevels.
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 OpenXmlCompositeElement)
Hidden	hidden Represents the following attribute in the schema: hidden
IconSet	iconSet Represents the following attribute in the schema: iconSet
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
KeyAttribute	keyAttribute Represents the following attribute in the schema: keyAttribute
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
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)
Measure	measure Represents the following attribute in the schema: measure
MeasureGroup	measureGroup Represents the following attribute in the schema: measureGroup
Measures	measures Represents the following attribute in the schema: measures
MemberValueDatatype	memberValueDatatype Represents the following attribute in the schema: memberValueDatatype
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)
OneField	oneField Represents the following attribute in the schema: oneField
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)
ParentSet	parentSet Represents the following attribute in the schema: parentSet
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Set	set Represents the following attribute in the schema: set
Time	time Represents the following attribute in the schema: time
Unbalanced	unbalanced Represents the following attribute in the schema: unbalanced
UnbalancedGroup	unbalancedGroup Represents the following attribute in the schema: unbalancedGroup
UniqueName	uniqueName Represents the following attribute in the schema: uniqueName
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)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
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 OpenXmlCompositeElement)
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 OpenXmlCompositeElement)
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 of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
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 nodes. (Inherited from OpenXmlCompositeElement)
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 of the current element's child elements. (Inherited from OpenXmlCompositeElement)
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. (Inherited from OpenXmlCompositeElement)
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 one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
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)