PivotAreaReference Class
Reference.When the object is serialized out as xml, its qualified name is x:reference.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Spreadsheet.PivotAreaReference
Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(FieldItem))> _
<ChildElementInfoAttribute(GetType(ExtensionList))> _
Public Class PivotAreaReference _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As PivotAreaReference
[ChildElementInfoAttribute(typeof(FieldItem))]
[ChildElementInfoAttribute(typeof(ExtensionList))]
public class PivotAreaReference : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
FieldItem <x:x>
ExtensionList <x:extLst>
[ISO/IEC 29500-1 1st Edition]
18.10.2.1 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.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.