pivotTableDefinition Class

Definition

Represents a PivotTable View..

This class is available in Office 2016 and above.

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

[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Location))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotFields))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.RowFields))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.RowItems))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ColumnFields))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ColumnItems))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PageFields))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.DataFields))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Formats))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ConditionalFormats))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ChartFormats))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotHierarchies))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotTableStyle))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotFilters))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.RowHierarchiesUsage))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ColumnHierarchiesUsage))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotTableDefinitionExtensionList))]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2016)]
[DocumentFormat.OpenXml.SchemaAttr(83, "pivotTableDefinition")]
public class pivotTableDefinition : DocumentFormat.OpenXml.OpenXmlCompositeElement
public class pivotTableDefinition : DocumentFormat.OpenXml.OpenXmlCompositeElement
[DocumentFormat.OpenXml.SchemaAttr(83, "pivotTableDefinition")]
public class pivotTableDefinition : DocumentFormat.OpenXml.OpenXmlCompositeElement
[DocumentFormat.OpenXml.SchemaAttr("xr:pivotTableDefinition")]
public class pivotTableDefinition : DocumentFormat.OpenXml.OpenXmlCompositeElement
[DocumentFormat.OpenXml.SchemaAttr("xr:pivotTableDefinition")]
public class pivotTableDefinition : DocumentFormat.OpenXml.TypedOpenXmlCompositeElement
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Location))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotFields))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.RowFields))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.RowItems))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ColumnFields))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ColumnItems))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PageFields))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.DataFields))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Formats))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ConditionalFormats))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ChartFormats))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotHierarchies))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotTableStyle))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotFilters))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.RowHierarchiesUsage))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.ColumnHierarchiesUsage))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotTableDefinitionExtensionList))>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2016)>]
[<DocumentFormat.OpenXml.SchemaAttr(83, "pivotTableDefinition")>]
type pivotTableDefinition = class
    inherit OpenXmlCompositeElement
type pivotTableDefinition = class
    inherit OpenXmlCompositeElement
[<DocumentFormat.OpenXml.SchemaAttr(83, "pivotTableDefinition")>]
type pivotTableDefinition = class
    inherit OpenXmlCompositeElement
[<DocumentFormat.OpenXml.SchemaAttr("xr:pivotTableDefinition")>]
type pivotTableDefinition = class
    inherit OpenXmlCompositeElement
[<DocumentFormat.OpenXml.SchemaAttr("xr:pivotTableDefinition")>]
type pivotTableDefinition = class
    inherit TypedOpenXmlCompositeElement
Public Class pivotTableDefinition
Inherits OpenXmlCompositeElement
Public Class pivotTableDefinition
Inherits TypedOpenXmlCompositeElement
Inheritance
Inheritance
Attributes

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

ApplyAlignmentFormats

Apply Alignment Formats

Represents the following attribute in the schema: applyAlignmentFormats

ApplyBorderFormats

Apply Border Formats

Represents the following attribute in the schema: applyBorderFormats

ApplyFontFormats

Apply Font Formats

Represents the following attribute in the schema: applyFontFormats

ApplyNumberFormats

Apply Number Formats

Represents the following attribute in the schema: applyNumberFormats

ApplyPatternFormats

Apply Pattern Formats

Represents the following attribute in the schema: applyPatternFormats

ApplyWidthHeightFormats

Apply Width / Height Formats

Represents the following attribute in the schema: applyWidthHeightFormats

AsteriskTotals

asteriskTotals

Represents the following attribute in the schema: asteriskTotals

AutoFormatId

Auto Format Id

Represents the following attribute in the schema: autoFormatId

CacheId

cacheId

Represents the following attribute in the schema: cacheId

ChartFormat

chartFormat

Represents the following attribute in the schema: chartFormat

ChartFormats

ChartFormats.

Represents the following element tag in the schema: x:chartFormats.

ChildElements

Gets all the child nodes of the current element.

(Inherited from OpenXmlElement)
ColumnFields

ColumnFields.

Represents the following element tag in the schema: x:colFields.

ColumnGrandTotals

colGrandTotals

Represents the following attribute in the schema: colGrandTotals

ColumnHeaderCaption

colHeaderCaption

Represents the following attribute in the schema: colHeaderCaption

ColumnHierarchiesUsage

ColumnHierarchiesUsage.

Represents the following element tag in the schema: x:colHierarchiesUsage.

ColumnItems

ColumnItems.

Represents the following element tag in the schema: x:colItems.

Compact

compact

Represents the following attribute in the schema: compact

CompactData

compactData

Represents the following attribute in the schema: compactData

ConditionalFormats

ConditionalFormats.

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

CreatedVersion

createdVersion

Represents the following attribute in the schema: createdVersion

CustomListSort

customListSort

Represents the following attribute in the schema: customListSort

DataCaption

dataCaption

Represents the following attribute in the schema: dataCaption

DataFields

DataFields.

Represents the following element tag in the schema: x:dataFields.

DataOnRows

dataOnRows

Represents the following attribute in the schema: dataOnRows

DataPosition

dataPosition

Represents the following attribute in the schema: dataPosition

DisableFieldList

disableFieldList

Represents the following attribute in the schema: disableFieldList

EditData

editData

Represents the following attribute in the schema: editData

EnableDrill

enableDrill

Represents the following attribute in the schema: enableDrill

EnableFieldProperties

enableFieldProperties

Represents the following attribute in the schema: enableFieldProperties

EnableWizard

enableWizard

Represents the following attribute in the schema: enableWizard

ErrorCaption

errorCaption

Represents the following attribute in the schema: errorCaption

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)
FieldListSortAscending

fieldListSortAscending

Represents the following attribute in the schema: fieldListSortAscending

FieldPrintTitles

fieldPrintTitles

Represents the following attribute in the schema: fieldPrintTitles

FirstChild

Gets the first child of the current OpenXmlElement element.

(Inherited from OpenXmlCompositeElement)
Formats

Formats.

Represents the following element tag in the schema: x:formats.

GrandTotalCaption

grandTotalCaption

Represents the following attribute in the schema: grandTotalCaption

GridDropZones

gridDropZones

Represents the following attribute in the schema: gridDropZones

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)
Indent

indent

Represents the following attribute in the schema: indent

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)
ItemPrintTitles

itemPrintTitles

Represents the following attribute in the schema: itemPrintTitles

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)
Location

Location.

Represents the following element tag in the schema: x:location.

MCAttributes

Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element.

(Inherited from OpenXmlElement)
MdxSubqueries

mdxSubqueries

Represents the following attribute in the schema: mdxSubqueries

MergeItem

mergeItem

Represents the following attribute in the schema: mergeItem

MinRefreshableVersion

minRefreshableVersion

Represents the following attribute in the schema: minRefreshableVersion

MissingCaption

missingCaption

Represents the following attribute in the schema: missingCaption

MultipleFieldFilters

multipleFieldFilters

Represents the following attribute in the schema: multipleFieldFilters

Name

name

Represents the following attribute in the schema: name

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

Represents the following attribute in the schema: outline

OutlineData

outlineData

Represents the following attribute in the schema: outlineData

PageFields

PageFields.

Represents the following element tag in the schema: x:pageFields.

PageOverThenDown

pageOverThenDown

Represents the following attribute in the schema: pageOverThenDown

PageStyle

pageStyle

Represents the following attribute in the schema: pageStyle

PageWrap

pageWrap

Represents the following attribute in the schema: pageWrap

Parent

Gets the parent element of the current element.

(Inherited from OpenXmlElement)
PivotFields

PivotFields.

Represents the following element tag in the schema: x:pivotFields.

PivotFilters

PivotFilters.

Represents the following element tag in the schema: x:filters.

PivotHierarchies

PivotHierarchies.

Represents the following element tag in the schema: x:pivotHierarchies.

PivotTableDefinitionExtensionList

PivotTableDefinitionExtensionList.

Represents the following element tag in the schema: x:extLst.

PivotTableStyle

PivotTableStyle.

Represents the following element tag in the schema: x:pivotTableStyleInfo.

PivotTableStyleName

pivotTableStyle

Represents the following attribute in the schema: pivotTableStyle

Prefix

Gets the namespace prefix of current element.

(Inherited from OpenXmlElement)
PreserveFormatting

preserveFormatting

Represents the following attribute in the schema: preserveFormatting

PrintDrill

printDrill

Represents the following attribute in the schema: printDrill

Published

published

Represents the following attribute in the schema: published

RowFields

RowFields.

Represents the following element tag in the schema: x:rowFields.

RowGrandTotals

rowGrandTotals

Represents the following attribute in the schema: rowGrandTotals

RowHeaderCaption

rowHeaderCaption

Represents the following attribute in the schema: rowHeaderCaption

RowHierarchiesUsage

RowHierarchiesUsage.

Represents the following element tag in the schema: x:rowHierarchiesUsage.

RowItems

RowItems.

Represents the following element tag in the schema: x:rowItems.

ShowCalculatedMembers

showCalcMbrs

Represents the following attribute in the schema: showCalcMbrs

ShowDataDropDown

showDataDropDown

Represents the following attribute in the schema: showDataDropDown

ShowDataTips

showDataTips

Represents the following attribute in the schema: showDataTips

ShowDrill

showDrill

Represents the following attribute in the schema: showDrill

ShowDropZones

showDropZones

Represents the following attribute in the schema: showDropZones

ShowEmptyColumn

showEmptyCol

Represents the following attribute in the schema: showEmptyCol

ShowEmptyRow

showEmptyRow

Represents the following attribute in the schema: showEmptyRow

ShowError

showError

Represents the following attribute in the schema: showError

ShowHeaders

showHeaders

Represents the following attribute in the schema: showHeaders

ShowItems

showItems

Represents the following attribute in the schema: showItems

ShowMemberPropertyTips

showMemberPropertyTips

Represents the following attribute in the schema: showMemberPropertyTips

ShowMissing

showMissing

Represents the following attribute in the schema: showMissing

ShowMultipleLabel

showMultipleLabel

Represents the following attribute in the schema: showMultipleLabel

StopImmersiveUi

immersive

Represents the following attribute in the schema: immersive

SubtotalHiddenItems

subtotalHiddenItems

Represents the following attribute in the schema: subtotalHiddenItems

Tag

tag

Represents the following attribute in the schema: tag

UpdatedVersion

updatedVersion

Represents the following attribute in the schema: updatedVersion

UseAutoFormatting

useAutoFormatting

Represents the following attribute in the schema: useAutoFormatting

VacatedStyle

vacatedStyle

Represents the following attribute in the schema: vacatedStyle

VisualTotals

visualTotals

Represents the following attribute in the schema: visualTotals

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)

When overridden in a derived class, creates a duplicate of the 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)

Applies to