Click or drag to resize

PivotTableDefinition Class

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.

Inheritance Hierarchy
SystemObject
  DocumentFormat.OpenXmlOpenXmlElement
    DocumentFormat.OpenXmlOpenXmlCompositeElement
      TypedOpenXmlCompositeElement
        DocumentFormat.OpenXml.Office2010.ExcelPivotTableDefinition

Namespace: DocumentFormat.OpenXml.Office2010.Excel
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll) Version: 2.20.0+Branch.release-v2.20.0.Sha.a873d3fbff9bffe179fea62486da950adf5be65d.a873d3fbff9bffe179fea62486da950adf5be65d
Syntax
public class PivotTableDefinition : TypedOpenXmlCompositeElement

The PivotTableDefinition type exposes the following members.

Constructors
 NameDescription
Public methodPivotTableDefinition Initializes a new instance of the PivotTableDefinition class.
Public methodPivotTableDefinition(IEnumerableOpenXmlElement) Initializes a new instance of the PivotTableDefinition class with the specified child elements.
Public methodPivotTableDefinition(OpenXmlElement) Initializes a new instance of the PivotTableDefinition class with the specified child elements.
Public methodPivotTableDefinition(String) Initializes a new instance of the PivotTableDefinition class from outer XML.
Top
Properties
 NameDescription
Public propertyAllocationMethod

allocationMethod, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: allocationMethod

Public propertyAltText

altText, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: altText

Public propertyAltTextSummary

altTextSummary, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: altTextSummary

Public propertyAutoApply

autoApply, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: autoApply

Public propertyCalculatedMembersInFilters

calculatedMembersInFilters, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: calculatedMembersInFilters

Public propertyChildElements Gets all the child nodes of the current element.
(Inherited from OpenXmlElement)
Public propertyConditionalFormats

ConditionalFormats.

Represents the following element tag in the schema: x14:conditionalFormats.

Public propertyEnableEdit

enableEdit, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: enableEdit

Public propertyExtendedAttributes Gets all extended attributes (attributes not defined in the schema) of the current element.
(Inherited from OpenXmlElement)
Public propertyFeatures 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)
Public propertyFillDownLabelsDefault

fillDownLabelsDefault, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: fillDownLabelsDefault

Public propertyFirstChild Gets the first child of the current OpenXmlElement element.
(Inherited from OpenXmlCompositeElement)
Public propertyHasAttributes Gets a value indicating whether the current element has any attributes.
(Inherited from OpenXmlElement)
Public propertyHasChildren Gets a value indicating whether the current element has any child elements.
(Inherited from OpenXmlCompositeElement)
Public propertyHideValuesRow

hideValuesRow, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: hideValuesRow

Public propertyInnerText Gets or sets the concatenated values of the node and all of its children.
(Inherited from OpenXmlCompositeElement)
Public propertyInnerXml Gets or sets the markup that represents only the child elements of the current element.
(Inherited from OpenXmlCompositeElement)
Public propertyLastChild 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)
Public propertyLocalName Gets the local name of the current element.
(Inherited from OpenXmlElement)
Public propertyMCAttributes Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element.
(Inherited from OpenXmlElement)
Public propertyNamespaceDeclarations Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration.
(Inherited from OpenXmlElement)
Public propertyNamespaceUri Gets the namespace URI of the current element.
(Inherited from OpenXmlElement)
Public propertyOpenXmlElementContext Gets the OpenXmlElementContext of the current element.
(Inherited from OpenXmlElement)
Public propertyOuterXml Gets the markup that represents the current element and all of its child elements.
(Inherited from OpenXmlElement)
Public propertyParent Gets the parent element of the current element.
(Inherited from OpenXmlElement)
Public propertyPivotChanges

PivotChanges.

Represents the following element tag in the schema: x14:pivotChanges.

Public propertyPivotEdits

PivotEdits.

Represents the following element tag in the schema: x14:pivotEdits.

Public propertyPrefix Gets the namespace prefix of current element.
(Inherited from OpenXmlElement)
Public propertyVisualTotalsForSets

visualTotalsForSets, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: visualTotalsForSets

Public propertyWeightExpression

weightExpression, this property is only available in Office 2010 and later.

Represents the following attribute in the schema: weightExpression

Public propertyXmlQualifiedName Gets the qualified name of the current element.
(Inherited from OpenXmlElement)
Public propertyXName Gets the qualified name of the current element.
(Inherited from OpenXmlElement)
Top
Methods
 NameDescription
Public methodAddAnnotation Adds an object to the current OpenXmlElement element's list of annotations.
(Inherited from OpenXmlElement)
Public methodAddChild 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)
Public methodAddNamespaceDeclaration Adds a namespace declaration to the current node.
(Inherited from OpenXmlElement)
Public methodAncestors Enumerates all of the current element's ancestors.
(Inherited from OpenXmlElement)
Public methodAnnotation(Type) Get the first annotation object of the specified type from the current OpenXmlElement element.
(Inherited from OpenXmlElement)
Public methodAnnotationT Get the first annotation object of the specified type from the current OpenXmlElement element.
(Inherited from OpenXmlElement)
Public methodAnnotations(Type) Gets a collection of annotations with the specified type for the current OpenXmlElement element.
(Inherited from OpenXmlElement)
Public methodAnnotationsT Gets a collection of annotations with the specified type for the current OpenXmlElement element.
(Inherited from OpenXmlElement)
Public methodAppend(IEnumerableOpenXmlElement) Appends each element from a list of elements to the end of the current element's list of child elements.
(Inherited from OpenXmlElement)
Public methodAppend(OpenXmlElement) Appends each element from an array of elements to the end of the current element's list of child elements.
(Inherited from OpenXmlElement)
Public methodAppendChildT Appends the specified element to the end of the current element's list of child nodes.
(Inherited from OpenXmlCompositeElement)
Public methodClearAllAttributes Clears all of the attributes, including both known attributes and extended attributes.
(Inherited from OpenXmlElement)
Public methodClone Creates a duplicate of the current node.
(Inherited from OpenXmlElement)
Public methodCloneNode When overridden in a derived class, creates a duplicate of the node.
(Overrides OpenXmlElementCloneNode(Boolean))
Public methodDescendantsT Enumerate all of the current element's descendants of type T.
(Inherited from OpenXmlElement)
Public methodElementsT Enumerates only the current element's children that have the specified type.
(Inherited from OpenXmlElement)
Public methodElementsAfter Enumerates all of the sibling elements that follow the current element and have the same parent as the current element.
(Inherited from OpenXmlElement)
Public methodElementsBefore Enumerates all of the sibling elements that precede the current element and have the same parent as the current element.
(Inherited from OpenXmlElement)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetAttribute Gets an Open XML attribute with the specified tag name and namespace URI.
(Inherited from OpenXmlElement)
Public methodGetAttributes Gets a list that contains a copy of all the attributes.
(Inherited from OpenXmlElement)
Public methodGetEnumerator Returns an enumerator that iterates through the child collection.
(Inherited from OpenXmlElement)
Public methodGetFirstChildT Finds the first child element in type T.
(Inherited from OpenXmlElement)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodInsertAfterT Inserts the specified element immediately after the specified reference element.
(Inherited from OpenXmlCompositeElement)
Public methodInsertAfterSelfT Inserts the specified element immediately after the current element.
(Inherited from OpenXmlElement)
Public methodInsertAtT Inserts the specified element at the specified index in the current element's list of child elements.
(Inherited from OpenXmlCompositeElement)
Public methodInsertBeforeT Inserts the specified element immediately before the specified reference element.
(Inherited from OpenXmlCompositeElement)
Public methodInsertBeforeSelfT Inserts the specified element immediately before the current element.
(Inherited from OpenXmlElement)
Public methodIsAfter Determines if the current element appears after a specified element in document order.
(Inherited from OpenXmlElement)
Public methodIsBefore Determines if the current element appears before a specified element in document order.
(Inherited from OpenXmlElement)
Public methodLookupNamespace Resolves the namespace prefix in the context of the current node.
(Inherited from OpenXmlElement)
Public methodLookupPrefix Finds the corresponding prefix for a namespace uri in the current element scope.
(Inherited from OpenXmlElement)
Public methodNextSibling 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)
Public methodPrependChildT Inserts the specified element at the beginning of the current element's list of child elements.
(Inherited from OpenXmlCompositeElement)
Public methodPreviousSibling 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)
Public methodRemove Removes the current element from its parent.
(Inherited from OpenXmlElement)
Public methodRemoveAllChildren Removes all of the current element's child elements.
(Inherited from OpenXmlCompositeElement)
Public methodRemoveAnnotations(Type) Removes the annotations of the specified type from the current OpenXmlElement element.
(Inherited from OpenXmlElement)
Public methodRemoveAnnotationsT Removes the annotations with the specified type from the current OpenXmlElement element.
(Inherited from OpenXmlElement)
Public methodRemoveAttribute Removes the attribute from the current element.
(Inherited from OpenXmlElement)
Public methodRemoveChildT Removes the specified child element from the current element's list of child elements.
(Inherited from OpenXmlCompositeElement)
Public methodRemoveNamespaceDeclaration Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix.
(Inherited from OpenXmlElement)
Public methodReplaceChildT Replaces a child element with another child element in the current element's list of child elements.
(Inherited from OpenXmlCompositeElement)
Public methodSetAttribute 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)
Public methodSetAttributes 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)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWriteTo Saves the current node to the specified XmlWriter.
(Inherited from OpenXmlElement)
Top
See Also