PivotTableDefinition Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Excel

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the PivotTableDefinition Class.

This class is available in Office 2010 and above.

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

public class PivotTableDefinition : DocumentFormat.OpenXml.OpenXmlCompositeElement

type PivotTableDefinition = class
    inherit OpenXmlCompositeElement

Public Class PivotTableDefinition
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

PivotTableDefinition

Remarks

2.4.19 pivotTableDefinition

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

A pivotTableDefinition element is a CT_PivotTableDefinition type element, as specified in section 2.6.32, that specifies additional properties of the PivotTable, as specified in [ISO/IEC-29500-1] section 18.10, view. See section 2.2.4.4 for how this element integrates with the Office Open XML file formats specified in [ISO/IEC-29500-1].

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="pivotTableDefinition" type="CT_PivotTableDefinition"/>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.6.32 CT_PivotTableDefinition

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

Referenced by: pivotTableDefinition

This element specifies additional properties of a PivotTable ([ISO/IEC-29500-1] section 18.10) view.

Child Elements:

pivotEdits: A CT_PivotEdits element that specifies a collection of PivotTable What-if Analysis edits.

pivotChanges: A CT_PivotChanges element that specifies a collection of PivotTable What-if Analysis changes.

conditionalFormats: A CT_ConditionalFormats element that specifies a collection of conditional formats applied to the PivotTable ([ISO/IEC-29500-1] section 18.10) view.

Attributes:

fillDownLabelsDefault: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies the behavior of PivotTable ([ISO/IEC-29500-1] section 18.10) fields (1) that are not a part of the PivotTable ([ISO/IEC-29500-1] section 18.10) view if they are later added to a PivotTable ([ISO/IEC-29500-1] section 18.10) view. MUST be a value from the following table.

Value	Meaning
"false"	Specifies that PivotTable ([ISO/IEC-29500-1] section 18.10) fields (1) added to the PivotTable ([ISO/IEC-29500-1] section 18.10) view behave as if the fillDownLabels attribute of the CT_PivotField elements associated with those PivotTable ([ISO/IEC-29500-1] section 18.10) fields (1) are set to "false".
"true"	Specifies that PivotTable ([ISO/IEC-29500-1] section 18.10) fields (1) added to the PivotTable ([ISO/IEC-29500-1] section 18.10) view behave as if the fillDownLabels attribute of the CT_PivotField elements associated with those PivotTable ([ISO/IEC-29500-1] section 18.10) fields (1) are set to "true".

visualTotalsForSets: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether hidden PivotTable ([ISO/IEC-29500-1] section 18.10) items will be included when calculating totals for PivotTable ([ISO/IEC-29500-1] section 18.10) named sets. MUST be a value from the following table.

Value	Meaning
"false"	Include hidden PivotTable ([ISO/IEC-29500-1] section 18.10) items in the set totals.
"true"	Do not include hidden PivotTable ([ISO/IEC-29500-1] section 18.10) items in the set totals.

calculatedMembersInFilters: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether PivotTable ([ISO/IEC-29500-1] section 18.10) OLAP-calculated members participate in PivotTable ([ISO/IEC-29500-1] section 18.10) manual filters and PivotTable ([ISO/IEC-29500-1] section 18.10) advanced filters.

Value	Meaning
"false"	PivotTable ([ISO/IEC-29500-1] section 18.10) OLAP-calculated members do not participate in PivotTable ([ISO/IEC-29500-1] section 18.10) manual filters and PivotTable ([ISO/IEC-29500-1] section 18.10) advanced filters.
"true"	PivotTable ([ISO/IEC-29500-1] section 18.10) OLAP-calculated members participate in PivotTable ([ISO/IEC-29500-1] section 18.10) manual filters and PivotTable ([ISO/IEC-29500-1] section 18.10) advanced filters as do other PivotTable ([ISO/IEC-29500-1] section 18.10) items.

altText: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the alternate text for the PivotTable ([ISO/IEC-29500-1] section 18.10) view. The string MUST be less than or equal to 2,000 characters in length.

altTextSummary: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the alternate text summary for the PivotTable ([ISO/IEC-29500-1] section 18.10) view. This string MUST be less than or equal to 2,000 characters in length.

enableEdit: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether PivotTable what-if analysis is enabled for the current PivotTable ([ISO/IEC-29500-1] section 18.10) view.

autoApply: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether PivotTable what-if analysis values are automatically allocated.

allocationMethod: An ST_AllocationMethod attribute that specifies the allocation method to use for PivotTable what-if analysis.

weightExpression: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the multidimensional expression (MDX) of the weight expression for weighted allocations of PivotTable what-if analysis values. This string MUST be less than or equal to 65,535 characters in length.

hideValuesRow: A Boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether the values row (2) in the PivotTable ([ISO/IEC-29500-1] section 18.10) report is visible.

Value	Meaning
"false"	The values row (2) in the PivotTable ([ISO/IEC-29500-1] section 18.10) report is visible.
"true"	The values row (2) in the PivotTable ([ISO/IEC-29500-1] section 18.10) report is not visible.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_PivotTableDefinition">

<xsd:sequence>

<xsd:element name="pivotEdits" type="CT_PivotEdits" minOccurs="0" maxOccurs="1"/>

<xsd:element name="pivotChanges" type="CT_PivotChanges" minOccurs="0" maxOccurs="1"/>

<xsd:element name="conditionalFormats" type="CT_ConditionalFormats" minOccurs="0"/>

</xsd:sequence>

<xsd:attribute name="fillDownLabelsDefault" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="visualTotalsForSets" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="calculatedMembersInFilters" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="altText" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="altTextSummary" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="enableEdit" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="autoApply" type="xsd:boolean" use="optional" default="false"/>

<xsd:attribute name="allocationMethod" type="ST_AllocationMethod" use="optional" default="equalAllocation"/>

<xsd:attribute name="weightExpression" type="x:ST_Xstring" use="optional"/>

<xsd:attribute name="hideValuesRow" type="xsd:boolean" use="optional" default="false"/>

</xsd:complexType>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Constructors

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

Properties

AllocationMethod	allocationMethod, this property is only available in Office 2010 and later. Represents the following attribute in the schema: allocationMethod
AltText	altText, this property is only available in Office 2010 and later. Represents the following attribute in the schema: altText
AltTextSummary	altTextSummary, this property is only available in Office 2010 and later. Represents the following attribute in the schema: altTextSummary
AutoApply	autoApply, this property is only available in Office 2010 and later. Represents the following attribute in the schema: autoApply
CalculatedMembersInFilters	calculatedMembersInFilters, this property is only available in Office 2010 and later. Represents the following attribute in the schema: calculatedMembersInFilters
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ConditionalFormats	ConditionalFormats. Represents the following element tag in the schema: x14:conditionalFormats.
EnableEdit	enableEdit, this property is only available in Office 2010 and later. Represents the following attribute in the schema: enableEdit
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)
FillDownLabelsDefault	fillDownLabelsDefault, this property is only available in Office 2010 and later. Represents the following attribute in the schema: fillDownLabelsDefault
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)
HideValuesRow	hideValuesRow, this property is only available in Office 2010 and later. Represents the following attribute in the schema: hideValuesRow
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)
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)
PivotChanges	PivotChanges. Represents the following element tag in the schema: x14:pivotChanges.
PivotEdits	PivotEdits. Represents the following element tag in the schema: x14:pivotEdits.
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
VisualTotalsForSets	visualTotalsForSets, this property is only available in Office 2010 and later. Represents the following attribute in the schema: visualTotalsForSets
WeightExpression	weightExpression, this property is only available in Office 2010 and later. Represents the following attribute in the schema: weightExpression
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)