PivotTableDefinition Members

Include Protected Members
Include Inherited Members

PivotTable Definition. It is the root element of PivotTablePart.

The PivotTableDefinition type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property ApplyAlignmentFormats Apply Alignment Formats.Represents the attribte in schema: applyAlignmentFormats
Public property ApplyBorderFormats Apply Border Formats.Represents the attribte in schema: applyBorderFormats
Public property ApplyFontFormats Apply Font Formats.Represents the attribte in schema: applyFontFormats
Public property ApplyNumberFormats Apply Number Formats.Represents the attribte in schema: applyNumberFormats
Public property ApplyPatternFormats Apply Pattern Formats.Represents the attribte in schema: applyPatternFormats
Public property ApplyWidthHeightFormats Apply Width / Height Formats.Represents the attribte in schema: applyWidthHeightFormats
Public property AsteriskTotals Asterisk Totals.Represents the attribte in schema: asteriskTotals
Public property AutoFormatId Auto Format Id.Represents the attribte in schema: autoFormatId
Public property CacheId PivotCache Definition Id.Represents the attribte in schema: cacheId
Public property ChartFormat Chart Format Id.Represents the attribte in schema: chartFormat
Public property ChartFormats PivotChart Formats.Represents the element tag in schema: x:chartFormats
Public property ChildElements Gets all the child nodes of this element. (Inherited from OpenXmlElement.)
Public property ColumnFields Column Fields.Represents the element tag in schema: x:colFields
Public property ColumnGrandTotals Grand Totals On Columns.Represents the attribte in schema: colGrandTotals
Public property ColumnHeaderCaption Column Header Caption.Represents the attribte in schema: colHeaderCaption
Public property ColumnHierarchiesUsage Column OLAP Hierarchy References.Represents the element tag in schema: x:colHierarchiesUsage
Public property ColumnItems Column Items.Represents the element tag in schema: x:colItems
Public property Compact Compact New Fields.Represents the attribte in schema: compact
Public property CompactData Compact Data.Represents the attribte in schema: compactData
Public property ConditionalFormats Conditional Formats.Represents the element tag in schema: x:conditionalFormats
Public property CreatedVersion PivotCache Created Version.Represents the attribte in schema: createdVersion
Public property CustomListSort Custom List AutoSort.Represents the attribte in schema: customListSort
Public property DataCaption Data Field Header Name.Represents the attribte in schema: dataCaption
Public property DataFields Data Fields.Represents the element tag in schema: x:dataFields
Public property DataOnRows Data On Rows.Represents the attribte in schema: dataOnRows
Public property DataPosition Default Data Field Position.Represents the attribte in schema: dataPosition
Public property DisableFieldList Disable Field List.Represents the attribte in schema: disableFieldList
Public property EditData Allow Edit Data.Represents the attribte in schema: editData
Public property EnableDrill Enable Drill Down.Represents the attribte in schema: enableDrill
Public property EnableFieldProperties Enable Field Properties.Represents the attribte in schema: enableFieldProperties
Public property EnableWizard Enable PivotTable Wizard.Represents the attribte in schema: enableWizard
Public property ErrorCaption Error Caption.Represents the attribte in schema: errorCaption
Public property ExtendedAttributes Gets all extended attributes (attributes not defined in schema) of the element. (Inherited from OpenXmlElement.)
Public property FieldListSortAscending Default Sort Order.Represents the attribte in schema: fieldListSortAscending
Public property FieldPrintTitles Field Print Titles.Represents the attribte in schema: fieldPrintTitles
Public property FirstChild Gets the first child of the OpenXmlElement. If there is no such OpenXmlElement, a null reference (Nothing in Visual Basic) is returned. (Inherited from OpenXmlCompositeElement.)
Public property Formats PivotTable Formats.Represents the element tag in schema: x:formats
Public property GrandTotalCaption Grand Totals Caption.Represents the attribte in schema: grandTotalCaption
Public property GridDropZones Enable Drop Zones.Represents the attribte in schema: gridDropZones
Public property HasAttributes Gets a boolean value indicating whether the current element has any attributes. (Inherited from OpenXmlElement.)
Public property HasChildren Gets a value indicating whether this element has any child elements. (Inherited from OpenXmlCompositeElement.)
Public property Indent Indentation for Compact Axis.Represents the attribte in schema: indent
Public property InnerText Gets or sets the concatenated values of the node and all its children. (Inherited from OpenXmlCompositeElement.)
Public property InnerXml Gets or sets the markup representing only the child nodes of this node. (Inherited from OpenXmlCompositeElement.)
Public property ItemPrintTitles Item Print Titles.Represents the attribte in schema: itemPrintTitles
Public property LastChild Gets the last child of the OpenXmlElement. If there is no such OpenXmlElement, a null reference (Nothing in Visual Basic) is returned. (Inherited from OpenXmlCompositeElement.)
Public property LocalName Gets the local name of the element. (Overrides OpenXmlElement.LocalName.)
Public property Location PivotTable Location.Represents the element tag in schema: x:location
Public property MCAttributes Markup Compatibility Attributes Set. Return null if there is no Markup Compatibility Attribute defined in this element. (Inherited from OpenXmlElement.)
Public property MergeItem Merge Titles.Represents the attribte in schema: mergeItem
Public property MinRefreshableVersion Minimum Refreshable Version.Represents the attribte in schema: minRefreshableVersion
Public property MissingCaption Caption for Missing Values.Represents the attribte in schema: missingCaption
Public property MultipleFieldFilters Multiple Field Filters.Represents the attribte in schema: multipleFieldFilters
Public property Name Name.Represents the attribte in schema: name
Public property NamespaceDeclarations Gets all the namespace declarations defined in the current element. Return an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement.)
Public property NamespaceUri Gets the namespace URI of this node. (Inherited from OpenXmlElement.)
Public property OpenXmlElementContext Gets the OpenXmlEementContext. (Inherited from OpenXmlElement.)
Public property OuterXml Gets the markup representing this element and all its child elements. (Inherited from OpenXmlElement.)
Public property Outline Outline New Fields.Represents the attribte in schema: outline
Public property OutlineData Outline Data Fields.Represents the attribte in schema: outlineData
Public property PageFields Page Field Items.Represents the element tag in schema: x:pageFields
Public property PageOverThenDown Page Over Then Down.Represents the attribte in schema: pageOverThenDown
Public property PageStyle Page Header Style Name.Represents the attribte in schema: pageStyle
Public property PageWrap Page Wrap.Represents the attribte in schema: pageWrap
Public property Parent Gets the parent of this element. (Inherited from OpenXmlElement.)
Public property PivotFields PivotTable Fields.Represents the element tag in schema: x:pivotFields
Public property PivotFilters Filters.Represents the element tag in schema: x:filters
Public property PivotHierarchies PivotTable OLAP Hierarchies.Represents the element tag in schema: x:pivotHierarchies
Public property PivotTableDefinitionExtensionList Future Feature Data Storage Area.Represents the element tag in schema: x:extLst
Public property PivotTablePart Gets the PivotTablePart associated with this element.
Public property PivotTableStyle PivotTable Style.Represents the element tag in schema: x:pivotTableStyleInfo
Public property PivotTableStyleName Table Style Name.Represents the attribte in schema: pivotTableStyle
Public property Prefix Gets the namespace prefix of this node. (Inherited from OpenXmlElement.)
Public property PreserveFormatting Preserve Formatting.Represents the attribte in schema: preserveFormatting
Public property PrintDrill Print Drill Indicators.Represents the attribte in schema: printDrill
Public property Published Data Fields Published.Represents the attribte in schema: published
Public property RowFields Row Fields.Represents the element tag in schema: x:rowFields
Public property RowGrandTotals Row Grand Totals.Represents the attribte in schema: rowGrandTotals
Public property RowHeaderCaption Row Header Caption.Represents the attribte in schema: rowHeaderCaption
Public property RowHierarchiesUsage Row OLAP Hierarchy References.Represents the element tag in schema: x:rowHierarchiesUsage
Public property RowItems Row Items.Represents the element tag in schema: x:rowItems
Public property ShowCalculatedMembers Show Calculated Members.Represents the attribte in schema: showCalcMbrs
Public property ShowDataDropDown Show Drop Down.Represents the attribte in schema: showDataDropDown
Public property ShowDataTips Show ToolTips on Data.Represents the attribte in schema: showDataTips
Public property ShowDrill Show Expand Collapse.Represents the attribte in schema: showDrill
Public property ShowDropZones Show Drop Zones.Represents the attribte in schema: showDropZones
Public property ShowEmptyColumn Show Empty Column.Represents the attribte in schema: showEmptyCol
Public property ShowEmptyRow Show Empty Row.Represents the attribte in schema: showEmptyRow
Public property ShowError Show Error.Represents the attribte in schema: showError
Public property ShowHeaders Show Field Headers.Represents the attribte in schema: showHeaders
Public property ShowItems Show Item Names.Represents the attribte in schema: showItems
Public property ShowMemberPropertyTips Show Member Property ToolTips.Represents the attribte in schema: showMemberPropertyTips
Public property ShowMissing Show Missing.Represents the attribte in schema: showMissing
Public property ShowMultipleLabel Show Multiple Labels.Represents the attribte in schema: showMultipleLabel
Public property StopImmersiveUi Stop Immersive UI.Represents the attribte in schema: immersive
Public property SubtotalHiddenItems Subtotal Hidden Items.Represents the attribte in schema: subtotalHiddenItems
Public property Tag PivotTable Custom String.Represents the attribte in schema: tag
Public property UpdatedVersion PivotTable Last Updated Version.Represents the attribte in schema: updatedVersion
Public property UseAutoFormatting Auto Formatting.Represents the attribte in schema: useAutoFormatting
Public property VacatedStyle Vacated Style.Represents the attribte in schema: vacatedStyle
Public property VisualTotals Total Visual Data.Represents the attribte in schema: visualTotals
Public property XmlQualifiedName Gets the qualified name of the node. (Inherited from OpenXmlElement.)

Top

Methods

  Name Description
Public method AddAnnotation Adds an object to the annotation list of this OpenXmlElement. (Inherited from OpenXmlElement.)
Public method AddNamespaceDeclaration Adds a namepace declaration to the current node. (Inherited from OpenXmlElement.)
Public method Ancestors() Enumerate all the ancestor nodes of this element. (Inherited from OpenXmlElement.)
Public method Annotation(Type) Get the first annotation object of the specified type from this OpenXmlElement. (Inherited from OpenXmlElement.)
Public method Annotation<T>() Get the first annotation object of the specified type from this OpenXmlElement. (Inherited from OpenXmlElement.)
Public method Annotations(Type) Gets a collection of annotations of the specified type for this OpenXmlElement. (Inherited from OpenXmlElement.)
Public method Annotations<T>() Gets a collection of annotations of the specified type for this OpenXmlElement. (Inherited from OpenXmlElement.)
Public method Append(array<OpenXmlElement[]) Adds the elements to the end of the list of child nodes, of this element. (Inherited from OpenXmlElement.)
Public method Append(IEnumerable<OpenXmlElement>) Adds the elements to the end of the list of child nodes, of this element. (Inherited from OpenXmlElement.)
Public method AppendChild<T>(T) Adds the specified element to the end of the list of child nodes, of this element. (Inherited from OpenXmlCompositeElement.)
Public method AppendChild<T>(T) Adds the specified element to the end of the list of child nodes, of this element. (Inherited from OpenXmlElement.)
Public method ClearAllAttributes Clear all the attributes ( known attributes + extended attributes ) (Inherited from OpenXmlElement.)
Public method Clone Creates a duplicate of this node. (Inherited from OpenXmlElement.)
Public method CloneNode Creates a duplicate of this node. (Overrides OpenXmlElement.CloneNode(Boolean).)
Public method Descendants<T>() Enumerate all the descendants elements (which type is T) of this element. Preorder traversering. (Inherited from OpenXmlElement.)
Public method Elements<T>() Enumerate for specific type of elements in child elements (Inherited from OpenXmlElement.)
Public method ElementsAfter Enumerate all the sibling elements after this element in same parent. (Inherited from OpenXmlElement.)
Public method ElementsBefore Enumerate all the sibling elements before this element in same parent. (Inherited from OpenXmlElement.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetAttribute Gets a Open XML attribute with the specifed tag name and namespace URI. (Inherited from OpenXmlElement.)
Public method GetAttributes Get a copy of all the attributes (Inherited from OpenXmlElement.)
Public method GetEnumerator Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement.)
Public method GetFirstChild<T> Find the first child element in type T (Inherited from OpenXmlElement.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method InsertAfter<T>(T, OpenXmlElement) Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement.)
Public method InsertAfter<T>(T, OpenXmlElement) Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlElement.)
Public method InsertAfterSelf<T> Inserts the specified element immediately after this element. (Inherited from OpenXmlElement.)
Public method InsertAt<T>(T, Int32) Inserts the specified element at the specified index in children. (Inherited from OpenXmlCompositeElement.)
Public method InsertAt<T>(T, Int32) Inserts the specified element at the specified index in children. (Inherited from OpenXmlElement.)
Public method InsertBefore<T>(T, OpenXmlElement) Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement.)
Public method InsertBefore<T>(T, OpenXmlElement) Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement.)
Public method InsertBeforeSelf<T> Inserts the specified element immediately before this element. (Inherited from OpenXmlElement.)
Public method IsAfter Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement.)
Public method IsBefore Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement.)
Public method Load Loads the DOM from the PivotTablePart.
Public method LookupNamespace Resolve the namespace prefix in the context of current node (Inherited from OpenXmlElement.)
Public method LookupPrefix Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement.)
Protected method MemberwiseClone (Inherited from Object.)
Public method NextSibling() Gets the OpenXmlElement immediately following this OpenXmlElement. If there is no next OpenXmlElement, a null reference (Nothing in Visual Basic) is returned. (Inherited from OpenXmlElement.)
Public method PrependChild<T>(T) Adds the specified element to the beginning of the list of child nodes for this element. (Inherited from OpenXmlCompositeElement.)
Public method PrependChild<T>(T) Adds the specified element to the beginning of the list of child nodes for this element. (Inherited from OpenXmlElement.)
Public method PreviousSibling() Gets the OpenXmlElement immediately preceding this OpenXmlElement. If there is no such preceding OpenXmlElement, a null reference (Nothing in Visual Basic) is returned. (Inherited from OpenXmlElement.)
Public method Reload Reloads the part content into Open XML DOM tree. It could be called multiple times and each time it is called, the tree will be reloaded; previous changes on the tree are abandoned. (Inherited from OpenXmlPartRootElement.)
Public method Remove Removes this element from its parent. (Inherited from OpenXmlElement.)
Public method RemoveAllChildren Remove all the child elements (Inherited from OpenXmlCompositeElement.)
Public method RemoveAnnotations(Type) Removes the annotations of the specified type from this OpenXmlElement. (Inherited from OpenXmlElement.)
Public method RemoveAnnotations<T>() Removes the annotations of the specified type from this OpenXmlElement. (Inherited from OpenXmlElement.)
Public method RemoveAttribute Remove the attribute from the element. (Inherited from OpenXmlElement.)
Public method RemoveChild<T>(T) Removes specified child element. (Inherited from OpenXmlCompositeElement.)
Public method RemoveChild<T>(T) Removes specified child element. (Inherited from OpenXmlElement.)
Public method RemoveNamespaceDeclaration Removes namespace declaration for a specific prefix. do nothing if the prefix is not existed. (Inherited from OpenXmlElement.)
Public method ReplaceChild<T>(OpenXmlElement, T) Replaces the child OpenXmlElement oldChild with newChild OpenXmlElement. (Inherited from OpenXmlCompositeElement.)
Public method ReplaceChild<T>(OpenXmlElement, T) Replaces the child OpenXmlElement oldChild with newChild OpenXmlElement. (Inherited from OpenXmlElement.)
Public method Save() Saves the data in the DOM tree back to the part. It could be called multiple times as well. Each time it is called, the stream will be flushed. (Inherited from OpenXmlPartRootElement.)
Public method Save(Stream) Save the DOM tree to stream. (Inherited from OpenXmlPartRootElement.)
Public method Save(PivotTablePart) Saves the DOM into the PivotTablePart.
Public method SetAttribute Set an attribute to the 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 method SetAttributes Set a bunch of attributes to the element. If a attribute is a known attribute, the value of the attribute is set. If a attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement.)
Public method ToString (Inherited from Object.)
Public method WriteTo Saves the current node to the specified XmlWriter. (Inherited from OpenXmlPartRootElement.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator (Inherited from OpenXmlElement.)

Top

See Also

Reference

PivotTableDefinition Class

DocumentFormat.OpenXml.Spreadsheet Namespace