PivotHierarchy Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

OLAP Hierarchy.

This class is available in Office 2007 and above.

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

public class PivotHierarchy : DocumentFormat.OpenXml.OpenXmlCompositeElement

type PivotHierarchy = class
    inherit OpenXmlCompositeElement

Public Class PivotHierarchy
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

PivotHierarchy

Remarks

[ISO/IEC 29500-1 1st Edition]

pivotHierarchy (OLAP Hierarchy)

Represents a OLAP hierarchy associated with the PivotTable. A hierarchy is a hierarchical representation of related OLAP dimensions. Hierarchies are defined on the OLAP server and cannot be changed in the PivotTable. [Example: Hierarchy "A" might be defined as follows:

Level 1Country/Region

Level 2State\Provence

Level 3City

end example]

[Example:

<sh:pivotHierarchy dragToRow="0" dragToCol="0" dragToPage="0" dragToData="1"/>  

end example]

Parent Elements
pivotHierarchies (§18.10.1.71)

Child Elements	Subclause
extLst (Future Feature Data Storage Area)	§18.2.10
members (Members)	§18.10.1.56
mps (OLAP Member Properties)	§18.10.1.59

Attributes	Description
caption (Hierarchy Caption)	Specifies the user defined caption of the hierarchy. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
dragOff (Drag Off)	Specifies a boolean value that indicates whether the user is allowed to remove this hierarchy from the PivotTable. A value of 1 or true indicates the user can remove this hierarchy from the PivotTable. A value of 0 or false indicates the user cannot remove the hierarchy from the PivotTable. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragToCol (Drag To Column)	Specifies a boolean value that indicates whether the user is allowed to put this hierarchy into the column area of the PivotTable. A value of 1 or true indicates the user can put this hierarchy into the column area of the PivotTable. A value of 0 or false indicates the user cannot remove this hierarchy. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragToData (Drag To Data)	Specifies a boolean value that indicates whether the user is allowed to put this hierarchy into the data area of the view. A value of 1 or true indicates A value of 0 or false indicates The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragToPage (Drag to Page)	Specifies a boolean value that indicates whether the user is allowed to put this hierarchy into the page area of the PivotTable. A value of 1 or true indicates the user can put this hierarchy into the page area of the PivotTable. A value of 0 or false indicates cannot put this hierarchy into the page area. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragToRow (Drag To Row)	Specifies a boolean value that indicates whether the user is allowed to put this hierarchy into the row area of the PivotTable. A value of 1 or true indicates the user can put this hierarchy into the row area of the PivotTable. A value of 0 or false indicates cannot put this hierarchy into the row area. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
includeNewItemsInFilter (Inclusive Manual Filter)	Specifies a boolean value that indicates whether the application will show only the items the user has selected. A value of 1 or true indicates the application will show only items the user has selected; all other items are hidden. A value of 0 or false indicates the application will show all items. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
multipleItemSelectionAllowed (Multiple Field Filters)	Specifies a boolean value that indicates whether the user can select multiple members when the hierarchy is in the page field area of the view. A value of 1 or true indicates the user can select multiple members. A value of 0 or false indicates the user cannot select multiple members. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
outline (Outline New Levels)	Specifies a boolean value that indicates whether new levels added to the PivotTable are shown in Outline mode. A value of 1 or true indicates new levels are shown in Outline mode. A value of 0 or false indicates new items are not shown in Outline mode. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showInFieldList (Show In Field List)	Specifies a boolean value that indicates whether this hierarchy is omitted from the field list. This attribute depends on how the application exposes a list of fields for PivotTables in the user interface. A value of 1 or true indicates this hierarchy is show in the field list or similar mechanism in the user interface. A value of 0 or false indicates is not shown in the field list. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
subtotalTop (New Levels Subtotals At Top)	Specifies a boolean value that indicates whether new levels added to the view will show their subtotals at the top. A value of 1 or true indicates new levels added to the view show their subtotals at the top. A value of 0 or false indicates new levels added to the view show their subtotals at the bottom. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

Caption	Hierarchy Caption Represents the following attribute in the schema: caption
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
DragOff	Drag Off Represents the following attribute in the schema: dragOff
DragToColumn	Drag To Column Represents the following attribute in the schema: dragToCol
DragToData	Drag To Data Represents the following attribute in the schema: dragToData
DragToPage	Drag to Page Represents the following attribute in the schema: dragToPage
DragToRow	Drag To Row Represents the following attribute in the schema: dragToRow
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 current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
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)
IncludeNewItemsInFilter	Inclusive Manual Filter Represents the following attribute in the schema: includeNewItemsInFilter
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)
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)
MemberProperties	OLAP Member Properties. Represents the following element tag in the schema: x:mps.
MultipleItemSelectionAllowed	Multiple Field Filters Represents the following attribute in the schema: multipleItemSelectionAllowed
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)
Outline	Outline New Levels Represents the following attribute in the schema: outline
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
ShowInFieldList	Show In Field List Represents the following attribute in the schema: showInFieldList
SubtotalTop	New Levels Subtotals At Top Represents the following attribute in the schema: subtotalTop
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)