PivotSelection Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

PivotTable Selection.

This class is available in Office 2007 and above.

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

public class PivotSelection : DocumentFormat.OpenXml.OpenXmlCompositeElement

type PivotSelection = class
    inherit OpenXmlCompositeElement

Public Class PivotSelection
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

PivotSelection

Remarks

[ISO/IEC 29500-1 1st Edition]

pivotSelection (PivotTable Selection)

A collection of PivotTable structure selections. A PivotTable structure selection is a way of specifying what cells in the PivotTable are selected. Instead of specifying cell addresses in a sqref, a particular area or structure within the PivotTable is specified. In this way there is semantic meaning regarding what is selected, rather than simply a list of cell or ranges contained in the selection. Typically fields on the row or column axis are selected.

[Example:For example, the innermost field (Product SubCategory) is selected in this PivotTable:

69bf0087-c567-4d34-88db-014e53f7bae8

The corresponding pivotSelection XML should look like this:

<pivotSelection pane="bottomRight" showHeader="1" axis="axisRow" dimension="2"  activeRow="11" activeCol="1" previousRow="11" previousCol="1" click="1"   r:id="rId1">  
  <pivotArea dataOnly="0" labelOnly="1" fieldPosition="0">  
    <references count="1">  
      <reference field="9" count="0"/>  
    </references>  
  </pivotArea>  
</pivotSelection>  

axis indicates that this selection is on the row axis, dimension indicates the field level within the row axis that is selected (zero-based index), activeCol and activeRow respectively indicate where in the grid the selection is located, and reference field indicates to which particular field the selection corresponds.

end example]

Parent Elements
sheetView (§18.3.1.87)

Child Elements	Subclause
pivotArea (Pivot Area)	§18.3.1.68

Attributes	Description
activeCol (Active Column)	The column (zero-based) of active cell for structure selection. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
activeRow (Active Row)	The row (zero-based) of active cell for structure selection. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
axis (Axis)	Axis of the PivotTable on which this selection lies. The possible values for this attribute are defined by the ST_Axis simple type (§18.18.1).
click (Click Count)	Number of clicks for this structure selection. For some selection combinations, subsequent clicks on the same target area cycles the actual selection through some variances. Therefore number of clicks on the selection shall be recorded, if it is desirable to restore this state of the selection cycle on load. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
count (Selection Count)	Number of selections for the structure selection. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
data (Data Selection)	Flag indicating whether the structure selection is for data only. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dimension (Dimension)	Indicates the field level within the axis that is selected (zero-based index). The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
extendable (Extendable)	Flag indicating whether the structure selection can have additional selections added to it. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
id (Relationship Id) Namespace: .../officeDocument/2006/relationships	Relationship Id pointing to the particular PivotTable Part corresponding to this selection. The possible values for this attribute are defined by the ST_RelationshipId simple type (§22.8.2.1).
label (Label)	Flag indicating whether the structure selection is for labels only (e.g., a grand total row is selected). The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
max (Maximum)	The maximum line the structure selection contains. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
min (Minimum)	The minimum line the structure selection contains. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
pane (Pane)	The pane to which this PivotTable structure selection belongs. The possible values for this attribute are defined by the ST_Pane simple type (§18.18.52).
previousCol (Previous Column Selection)	1-based index to the column immediately left of the structure selection. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
previousRow (Previous Row)	1-based index to the row immediately above the structure selection. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
showHeader (Show Header)	Flag indicating whether selection toggle from data only to header only to both is enabled. False means disabled. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
start (Start)	The line the structure selection begins (zero-based). This is the line clicked to initiate the structure selection. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

ActiveColumn	Active Column Represents the following attribute in the schema: activeCol
ActiveRow	Active Row Represents the following attribute in the schema: activeRow
Axis	Axis Represents the following attribute in the schema: axis
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Click	Click Count Represents the following attribute in the schema: click
Count	Selection Count Represents the following attribute in the schema: count
Data	Data Selection Represents the following attribute in the schema: data
Dimension	Dimension Represents the following attribute in the schema: dimension
Extendable	Extendable Represents the following attribute in the schema: extendable
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)
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)
Id	Relationship Id Represents the following attribute in the schema: r:id
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)
Label	Label Represents the following attribute in the schema: label
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)
Max	Maximum Represents the following attribute in the schema: max
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
Min	Minimum Represents the following attribute in the schema: min
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)
Pane	Pane Represents the following attribute in the schema: pane
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
PivotArea	Pivot Area. Represents the following element tag in the schema: x:pivotArea.
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
PreviousColumn	Previous Column Selection Represents the following attribute in the schema: previousCol
PreviousRow	Previous Row Represents the following attribute in the schema: previousRow
ShowHeader	Show Header Represents the following attribute in the schema: showHeader
Start	Start Represents the following attribute in the schema: start
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)