PivotAreaReference Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Reference.

This class is available in Office 2007 and above.

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

public class PivotAreaReference : DocumentFormat.OpenXml.OpenXmlCompositeElement

type PivotAreaReference = class
    inherit OpenXmlCompositeElement

Public Class PivotAreaReference
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

PivotAreaReference

Remarks

[ISO/IEC 29500-1 1st Edition]

reference (Reference)

Represents a set of selected fields and selected items within those fields.

[Example:

<sh:reference field="4294967294" count="1" selected="0">  
  <sh:x v="0"/>  
</sh:reference>  

end example]

Parent Elements
references (§18.10.2.2)

Child Elements	Subclause
extLst (Future Feature Data Storage Area)	§18.2.10
x (Shared Items Index)	§18.10.1.97

Attributes	Description
avgSubtotal (Include Average Filter)	Specifies a boolean value that indicates whether the 'average' aggregate function is included in the filter. A value of 1 or true indicates the average aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
byPosition (Positional Reference)	Specifies a boolean value that indicates whether the item is referred to by position rather than item index. A value of 1 or true indicates the item is referred to by position. A value of 0 or false indicates the item is referred to by index. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
count (Item Index Count)	Specifies the number of item indexes in the collection of indexes (x tags). The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
countASubtotal (Include CountA Filter)	Specifies a boolean value that indicates whether the 'countA' subtotal is included in the filter. A value of 1 or true indicates the count aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
countSubtotal (Include Count Subtotal)	Specifies a boolean value that indicates whether the count aggregate function is included in the filter. A value of 1 or true indicates the count aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
defaultSubtotal (Include Default Filter)	Specifies a boolean value that indicates whether the default subtotal is included in the filter. A value of 1 or true indicates the default subtotal is included in the filter. The default is to display the total or the grand total. A value of 0 or false indicates another subtotal or aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
field (Field Index)	Specifies the index of the field to which this filter refers. A value of -2 indicates the 'data' field. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
maxSubtotal (Include Maximum Filter)	Specifies a boolean value that indicates whether the 'maximum' aggregate function is included in the filter. A value of 1 or true indicates the maximum aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
minSubtotal (Include Minimum Filter)	Specifies a boolean value that indicates whether the 'minimum' aggregate function is included in the filter. A value of 1 or true indicates the minimum aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
productSubtotal (Include Product Filter)	Specifies a boolean value that indicates whether the 'product' aggregate function is included in the filter. A value of 1 or true indicates the product aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
relative (Relative Reference)	Specifies a boolean value that indicates whether the item is referred to by a relative reference rather than an absolute reference. This attribute is used if posRef is set to true. A value of 1 or true indicates the item is referred to by a relative reference. A value of 0 or false indicates the item is referred to by an absolute reference. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
selected (Selected)	Specifies a boolean value that indicates whether this field has selection. This attribute is used when the PivotTable is in Outline view. It is also used when both header and data cells have selection. A value of 1 or true indicates the field has selection. A value of 0 or false indicates the field does not have selection. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
stdDevPSubtotal (Include StdDevP Filter)	Specifies a boolean value that indicates whether the population standard deviation aggregate function is included in the filter. A value of 1 or true indicates the population standard deviation aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
stdDevSubtotal (Include StdDev Filter)	Specifies a boolean value that indicates whether the standard deviation aggregate function is included in the filter. A value of 1 or true indicates the standard deviation aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
sumSubtotal (Include Sum Filter)	Specifies a boolean value that indicates whether the sum aggregate function is included in the filter. A value of 1 or true indicates the sum aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
varPSubtotal (Include VarP Filter)	Specifies a boolean value that indicates whether the population variance aggregate function is included in the filter. A value of 1 or true indicates the population variance aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
varSubtotal (Include Var Filter)	Specifies a boolean value that indicates whether the variance aggregate function is included in the filter. A value of 1 or true indicates the variance aggregation function is included in the filter. A value of 0 or false indicates another aggregation function is included in the filter. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

ApplyProductInSubtotal	Include Product Filter Represents the following attribute in the schema: productSubtotal
ApplyStandardDeviationInSubtotal	Include StdDev Filter Represents the following attribute in the schema: stdDevSubtotal
ApplyStandardDeviationPInSubtotal	Include StdDevP Filter Represents the following attribute in the schema: stdDevPSubtotal
ApplyVarianceInSubtotal	Include Var Filter Represents the following attribute in the schema: varSubtotal
ApplyVariancePInSubtotal	Include VarP Filter Represents the following attribute in the schema: varPSubtotal
AverageSubtotal	Include Average Filter Represents the following attribute in the schema: avgSubtotal
ByPosition	Positional Reference Represents the following attribute in the schema: byPosition
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Count	Item Index Count Represents the following attribute in the schema: count
CountASubtotal	Include CountA Filter Represents the following attribute in the schema: countASubtotal
CountSubtotal	Include Count Subtotal Represents the following attribute in the schema: countSubtotal
DefaultSubtotal	Include Default Filter Represents the following attribute in the schema: defaultSubtotal
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)
Field	Field Index Represents the following attribute in the schema: field
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)
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)
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)
MaxSubtotal	Include Maximum Filter Represents the following attribute in the schema: maxSubtotal
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
MinSubtotal	Include Minimum Filter Represents the following attribute in the schema: minSubtotal
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)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Relative	Relative Reference Represents the following attribute in the schema: relative
Selected	Selected Represents the following attribute in the schema: selected
SumSubtotal	Include Sum Filter Represents the following attribute in the schema: sumSubtotal
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)