PivotArea Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Calculated Item Location.

This class is available in Office 2007 and above.

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

public class PivotArea : DocumentFormat.OpenXml.OpenXmlCompositeElement

type PivotArea = class
    inherit OpenXmlCompositeElement

Public Class PivotArea
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

PivotArea

Remarks

[ISO/IEC 29500-1 1st Edition]

pivotArea (Pivot Area)

Rule describing a PivotTable selection.

Parent Elements
autoSortScope (§18.10.1.1); calculatedItem (§18.10.1.8); chartFormat (§18.10.1.12); format (§18.10.1.35); pivotAreas (§18.10.1.66); pivotSelection (§18.3.1.69)

Child Elements	Subclause
extLst (Future Feature Data Storage Area)	§18.2.10
references (References)	§18.10.2.2

Attributes	Description
axis (Axis)	The region of the PivotTable to which this rule applies. The possible values for this attribute are defined by the ST_Axis simple type (§18.18.1).
cacheIndex (Cache Index)	Flag indicating whether any indexes refer to fields or items in the Pivot cache and not the view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
collapsedLevelsAreSubtotals (Collapsed Levels Are Subtotals)	Flag indicating if collapsed levels/dimensions are considered subtotals. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dataOnly (Data Only)	Flag indicating whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
field (Field Index)	Index of the field that this selection rule refers to. The possible values for this attribute are defined by the W3C XML Schema int datatype.
fieldPosition (Field Position)	Position of the field within the axis to which this rule applies. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
grandCol (Include Column Grand Total)	Flag indicating whether the column grand total is included. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
grandRow (Include Row Grand Total)	Flag indicating whether the row grand total is included. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
labelOnly (Labels Only)	Flag indicating whether only the item labels for an item selection are selected and does not include the data values (in the data area of the view). The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
offset (Offset Reference)	A Reference that specifies a subset of the selection area. Points are relative to the top left of the selection area. The possible values for this attribute are defined by the ST_Ref simple type (§18.18.62).
outline (Outline)	Flag indicating whether the rule refers to an area that is in outline mode. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
type (Rule Type)	Indicates the type of selection rule. The possible values for this attribute are defined by the ST_PivotAreaType simple type (§18.18.58).

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

Axis	Axis Represents the following attribute in the schema: axis
CacheIndex	Cache Index Represents the following attribute in the schema: cacheIndex
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
CollapsedLevelsAreSubtotals	Collapsed Levels Are Subtotals Represents the following attribute in the schema: collapsedLevelsAreSubtotals
DataOnly	Data Only Represents the following attribute in the schema: dataOnly
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
ExtensionList	Future Feature Data Storage Area. Represents the following element tag in the schema: x:extLst.
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)
Field	Field Index Represents the following attribute in the schema: field
FieldPosition	Field Position Represents the following attribute in the schema: fieldPosition
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
GrandColumn	Include Column Grand Total Represents the following attribute in the schema: grandCol
GrandRow	Include Row Grand Total Represents the following attribute in the schema: grandRow
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)
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)
LabelOnly	Labels Only Represents the following attribute in the schema: labelOnly
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)
Offset	Offset Reference Represents the following attribute in the schema: offset
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
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
PivotAreaReferences	References. Represents the following element tag in the schema: x:references.
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Type	Rule Type Represents the following attribute in the schema: type
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)