PivotField PivotField PivotField Class

Definition

PivotTable Field. When the object is serialized out as xml, its qualified name is x:pivotField.

[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.Items))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.AutoSortScope))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Spreadsheet.PivotFieldExtensionList))]
public class PivotField : DocumentFormat.OpenXml.OpenXmlCompositeElement
type PivotField = class
    inherit OpenXmlCompositeElement
Public Class PivotField
Inherits OpenXmlCompositeElement
Inheritance
Attributes

Remarks

[ISO/IEC 29500-1 1st Edition]

pivotField (PivotTable Field)

Represents a single field in the PivotTable. This element contains information about the field, including the collection of items in the field.

[Example:

<pivotField axis="axisRow" allDrilled="1" showAll="0" measureFilter="1"  sortType="descending">  
  <items count="8">  
    <item s="1" c="1" x="0"/>  
    <item s="1" c="1" x="1"/>  
    <item c="1" x="2"/>  
    <item c="1" x="3"/>  
    <item c="1" x="4"/>  
    <item c="1" x="5"/>  
    <item c="1" x="6"/>  
    <item t="default"/>  
  </items>  
  <autoSortScope>  
    <pivotArea dataOnly="0" outline="0" fieldPosition="0">  
      <references count="2">  
        <reference field="4294967294" count="1" selected="0">  
          <x v="0"/>  
        </reference>  
        <reference field="25" count="1" selected="0">  
          <x v="0"/>  
        </reference>  
      </references>  
    </pivotArea>  
  </autoSortScope>  
</pivotField>  

end example]

Parent Elements
pivotFields (§18.10.1.70)
Child Elements Subclause
autoSortScope (AutoSort Scope) §18.10.1.1
extLst (Future Feature Data Storage Area) §18.2.10
items (Field Items) §18.10.1.46
Attributes Description
allDrilled (All Items Expanded) Specifies a boolean value that indicates whether all items in the field are expanded. Applies only to OLAP PivotTables.

A value of 1 or true indicates all items in the field are expanded.

A value of 0 or false indicates all items are not expanded. However some items might be expanded.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
autoShow (Auto Show) Specifies a boolean value that indicates whether an "AutoShow" filter is applied to this field. This attribute depends on the implementation of filtering in the application.

A value of 1 or true indicates an "AutoShow" filter is applied to the field.

A value of 0 or false indicates an "AutoShow" filter is not applied.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
avgSubtotal (Average) Specifies a boolean value that indicates whether to apply the 'Average' aggregation function in the subtotal of this field.

A value of 1 or true indicates the subtotal for this field is 'Average.'

A value of 0 or false indicates a different aggregation function is applied to the subtotal for this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
axis (Axis) Specifies the region of the PivotTable that this field is displayed.

The possible values for this attribute are defined by the ST_Axis simple type (§18.18.1).
compact (Compact) Specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this PivotTable resides.

A value of 1 or true indicates the next field should be displayed in the same column of the sheet.

A value of 0 or false indicates each pivot field will display in its own column in the sheet.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
countASubtotal (CountA) Specifies a boolean value that indicates whether to apply the 'countA' aggregation function in the subtotal of this field.

A value of 1 or true indicates the subtotal for this field is 'countA.'

A value of 0 or false indicates a different aggregation function is applied to the subtotal for this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
countSubtotal (Count) Specifies a boolean value that indicates whether to apply the 'count' aggregation function in the subtotal of this field.

A value of 1 or true indicates the subtotal for this field is 'count.'

A value of 0 or false indicates a different aggregation vfunction is applied to the subtotal for this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dataField (Data Field) Specifies a boolean value that indicates whether this field appears in the data region of the PivotTable.

A value of 1 or true indicates this field appears in the data region of the PivotTable.

A value of 0 or false indicates this field appears in another region of the PivotTable.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dataSourceSort (Data Source Sort) Specifies a boolean value that indicates whether sort is applied to this field in the data source.

A value of 1 or true indicates this field is sorted in the data source.

A value of 0 or false indicates this field is not sorted in the data source.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
defaultAttributeDrillState (Drill State) Specifies a boolean value that indicates the drill state of the attribute hierarchy in an OLAP-based PivotTable.

A value of 1 or true indicates the attribute hierarchy is expanded.

A value of 0 or false indicates the attribute hierarchy is collapsed.

This attribute is designed to allow the application to issue more optimized queries when all items of each field have the same drill state.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
defaultSubtotal (Show Default Subtotal) Specifies a boolean value that indicates whether the default subtotal aggregation function is displayed for this field.

A value of 1 or true indicates the default subtotal aggregation function is displayed for this field.

A value of 0 or false indicates the default aggregation function is not displayed.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragOff (Drag Off) Specifies a boolean value that indicates whether the field can be removed from the PivotTable.

A value of 1 or true indicates the field can be removed from the PivotTable.

A value of 0 or false indicates the field cannot be removed from the PivotTable.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragToCol (Drag To Column) Specifies a boolean value that indicates whether the field can be dragged to the column axis.

A value of 1 or true indicates the field can be dragged to the column axis.

A value of 0 or false indicates the field cannot be dragged to the column axis.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragToData (Field Can Drag to Data) Specifies a boolean value that indicates whether the field can be dragged to the data region.

A value of 1 or true indicates the field can be dragged to the data region.

A value of 0 or false indicates the field cannot be dragged to the data region.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragToPage (Drag Field to Page) Specifies a boolean value that indicates whether the field can be dragged to the page region.

A value of 1 or true indicates the field can be dragged to the page region.

A value of 0 or false indicates the field cannot be dragged to the page region.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
dragToRow (Drag To Row) Specifies a boolean value that indicates whether the field can be dragged to the row axis.

A value of 1 or true indicates the field can be dragged to the row axis.

A value of 0 or false indicates the field cannot be dragged to the row axis.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
hiddenLevel (Hidden Level) Specifies a boolean value that indicates whether there is a hidden level in the PivotTable. This attribute applies to OLAP-based PivotTables only.

A value of 1 or true indicates the OLAP PivotTable contains a hidden level.

A value of 0 or false indicates the OLAP PivotTable does not contain any hidden levels.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
hideNewItems (Hide New Items) Specifies a boolean value that indicates whether new items that appear after a refresh should be hidden by default.

A value of 1 or true indicates that items that appear after a refresh should be hidden by default.

A value of 0 or false indicates that items that appear after a refresh should be shown by default.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
includeNewItemsInFilter (Inclusive Manual Filter) Specifies a boolean value that indicates whether manual filter is in inclusive mode.

A value of 1 or true indicates the manual filter is inclusive.

A value of 0 or false indicates the manual filter is not inclusive.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
insertBlankRow (Insert Blank Row) Specifies a boolean value that indicates whether to insert a blank row after each item.

A value of 1 or true indicates that a blank row is inserted after each item.

A value of 0 or false indicates no additional rows are inserted after each item.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
insertPageBreak (Insert Item Page Break) Specifies a boolean value that indicates whether to insert a page break after each item.

A value of 1 or true indicates that a page break is inserted after each item.

A value of 0 or false indicates no page breaks are inserted after items.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
itemPageCount (Items Per Page Count) Specifies the number of items showed per page in the PivotTable.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
maxSubtotal (Max Subtotal) Specifies a boolean value that indicates whether to apply the 'max' aggregation function in the subtotal of this field.

A value of 1 or true indicates that the 'max' aggregation function is applied in the subtotal for this field.

A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
measureFilter (Measure Filter) Specifies a boolean value that indicates whether field has a measure based filter.

A value of 1 or true indicates the field has a measure-based filter.

A value of 0 or false indicates does not have a measure-based filter.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
minSubtotal (Min Subtotal) Specifies a boolean value that indicates whether to apply the 'min' aggregation function in the subtotal of this field.

A value of 1 or true indicates that the 'min' aggregation function is applied in the subtotal for this field.

A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
multipleItemSelectionAllowed (Multiple Field Filters) Specifies a boolean value that indicates whether the field can have multiple items selected in the page field.

A value of 1 or true indicates the PivotTable can have multiple items selected in the page field.

A value of 0 or false indicates the PivotTable cannot have multiple items selected in the page field. This attribute depends on the application support for selecting multiple items in page fields.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
name (Field Name) Specifies the name of the field.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
nonAutoSortDefault (Auto Sort) Specifies a boolean value that indicates whether sort operation that is applied to field should be AutoSort operation or simple data sort operation.

A value of 1 or true indicates that an AutoSort operation is applied to the field.

A value of 0 or false indicates a simple data sort operation is applied to the field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
numFmtId (Number Format Id) Specifies the identifier of the number format to apply to this field. Number formats are written to the styles part. See the Styles section (§18.8) for more information on number formats.

Formatting information provided by cell table and by PivotTable need not agree. If the two formats differ, the cell-level formatting takes precedence. If you change the layout the PivotTable, the PivotTable formatting will then take precedence.

The possible values for this attribute are defined by the ST_NumFmtId simple type (§18.18.47).
outline (Outline Items) Specifies a boolean value that indicates whether the items in this field should be shown in Outline form.

A value of 1 or true indicates the items in this field is shown in Outline form.

A value of 0 or false indicates the items in this field will not be shown in Outline form. This attribute depends on the application support for displaying items in Outline form.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
productSubtotal (Product Subtotal) Specifies a boolean value that indicates whether to apply 'product' aggregation function in the subtotal of this field.

A value of 1 or true indicates that the 'product' aggregation function is applied in the subtotal for this field.

A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
rankBy (Auto Show Rank By) Specifies the index of the data field by which AutoShow will rank.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
serverField (Server-based Page Field) Specifies a boolean value that indicates whether this is a server-based page field.

A value of 1 or true indicates this is a server-based page field.

A value of 0 or false indicates this is a local page field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showAll (Show All Items) Specifies a boolean value that indicates whether to show all items for this field.

A value of 1 or true indicates that all items be shown.

A value of 0 or false indicates items be shown according to user specified criteria.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showDropDowns (Show PivotField Header Drop Downs) Specifies a boolean value that indicates whether to hide drop down buttons on PivotField headers. This attribute depends on the application implementation for filtering in the user interface.

A value of 1 or true indicates the application will display some mechanism for selecting and applying filters – [Example: A dropdown menu end example] – in the user interface.

A value of 0 or false indicates for mechanism for applying a filter is displayed in the user interface.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showPropAsCaption (Show As Caption) Specifies a boolean value that indicates whether to show the property as a member caption.

A value of 1 or true indicates the property is shown as a member caption.

A value of 0 or false indicates the property will not be shown as a member caption.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showPropCell (Show Member Property in Cell) Specifies a boolean value that indicates whether to show the member property value in a PivotTable cell.

A value of 1 or true indicates the property value is shown in a PivotTable cell.

A value of 0 or false indicates the property value will not be shown in a PivotTable cell.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
showPropTip (Show Member Property ToolTip) Specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate PivotTable cells.

A value of 1 or true indicates the property value is shown in a tooltip in the user interface.

A value of 0 or false indicates the property will not be shown in a tooltip. This attribute depends on whether the application employs tooltips or similar mechanism in the user interface.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
sortType (Auto Sort Type) Specifies the type of sort that is applied to this field.

The possible values for this attribute are defined by the ST_FieldSortType simple type (§18.18.28).
stdDevPSubtotal (StdDevP Subtotal) Specifies a boolean value that indicates whether to apply the 'stdDevP' aggregation function in the subtotal of this field.

A value of 1 or true indicates that the 'stdDevP' aggregation function is applied in the subtotal for this field.

A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
stdDevSubtotal (StdDev Subtotal) Specifies a boolean value that indicates whether to use 'stdDev' in the subtotal of this field.

A value of 1 or true indicates that the 'stdDev' aggregation function is applied in the subtotal for this field.

A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
subtotalCaption (Custom Subtotal Caption) Specifies the custom text that is displayed for the subtotals label.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
subtotalTop (Subtotals At Top) Specifies a boolean value that indicates whether to display subtotals at the top of the group. Applies only when Outline its true.

A value of 1 or true indicates a subtotal is display at the top of the group.

A value of 0 or false indicates subtotal will not be displayed at the top of the group.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
sumSubtotal (Sum Subtotal) Specifies a boolean value that indicates whether apply the 'sum' aggregation function in the subtotal of this field.

A value of 1 or true indicates the 'sum' aggregation function is applied in the subtotal of this field.

A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
topAutoShow (Top Auto Show) Specifies a boolean value that indicates whether an AutoShow filter applied to this field is set to show the top ranked values.

A value of 1 or true indicates whether an AutoShow filter will show top values for this field.

A value of 0 or false indicates bottom ranked values are shown.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
uniqueMemberProperty (Unique Member Property) Specifies the unique name of the member property to be used as a caption for the field and field items.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
varPSubtotal (VarP Subtotal) Specifies a boolean value that indicates whether to apply the 'varP' aggregation function in the subtotal of this field.

A value of 1 or true indicates the 'varP' aggregation function is applied in the subtotal of this field.

A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
varSubtotal (Variance Subtotal) Specifies a boolean value that indicates whether to apply the 'variance' aggregation function in the subtotal of this field.

A value of 1 or true indicates the 'variance' aggregation function is applied in the subtotal of this field.

A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.

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_PivotField) is located in §A.2. end note]

� ISO/IEC29500: 2008.

Constructors

PivotField() PivotField() PivotField()

Initializes a new instance of the PivotField class.

PivotField(IEnumerable<OpenXmlElement>) PivotField(IEnumerable<OpenXmlElement>) PivotField(IEnumerable<OpenXmlElement>)

Initializes a new instance of the PivotField class with the specified child elements.

PivotField(OpenXmlElement[]) PivotField(OpenXmlElement[]) PivotField(OpenXmlElement[])

Initializes a new instance of the PivotField class with the specified child elements.

PivotField(String) PivotField(String) PivotField(String)

Initializes a new instance of the PivotField class from outer XML.

Properties

AllDrilled AllDrilled AllDrilled

All Items Expanded.Represents the following attribute in the schema: allDrilled

ApplyProductInSubtotal ApplyProductInSubtotal ApplyProductInSubtotal

Product Subtotal.Represents the following attribute in the schema: productSubtotal

ApplyStandardDeviationInSubtotal ApplyStandardDeviationInSubtotal ApplyStandardDeviationInSubtotal

StdDev Subtotal.Represents the following attribute in the schema: stdDevSubtotal

ApplyStandardDeviationPInSubtotal ApplyStandardDeviationPInSubtotal ApplyStandardDeviationPInSubtotal

StdDevP Subtotal.Represents the following attribute in the schema: stdDevPSubtotal

ApplyVarianceInSubtotal ApplyVarianceInSubtotal ApplyVarianceInSubtotal

Variance Subtotal.Represents the following attribute in the schema: varSubtotal

ApplyVariancePInSubtotal ApplyVariancePInSubtotal ApplyVariancePInSubtotal

VarP Subtotal.Represents the following attribute in the schema: varPSubtotal

AutoShow AutoShow AutoShow

Auto Show.Represents the following attribute in the schema: autoShow

AutoSortScope AutoSortScope AutoSortScope

AutoSort Scope. Represents the following element tag in the schema: x:autoSortScope

AverageSubTotal AverageSubTotal AverageSubTotal

Average.Represents the following attribute in the schema: avgSubtotal

Axis Axis Axis

Axis.Represents the following attribute in the schema: axis

ChildElements ChildElements ChildElements

Gets all the child nodes of the current element.

(Inherited from OpenXmlElement)
Compact Compact Compact

Compact.Represents the following attribute in the schema: compact

CountASubtotal CountASubtotal CountASubtotal

CountA.Represents the following attribute in the schema: countASubtotal

CountSubtotal CountSubtotal CountSubtotal

Count.Represents the following attribute in the schema: countSubtotal

DataField DataField DataField

Data Field.Represents the following attribute in the schema: dataField

DataSourceSort DataSourceSort DataSourceSort

Data Source Sort.Represents the following attribute in the schema: dataSourceSort

DefaultAttributeDrillState DefaultAttributeDrillState DefaultAttributeDrillState

Drill State.Represents the following attribute in the schema: defaultAttributeDrillState

DefaultSubtotal DefaultSubtotal DefaultSubtotal

Show Default Subtotal.Represents the following attribute in the schema: defaultSubtotal

DragOff DragOff DragOff

Drag Off.Represents the following attribute in the schema: dragOff

DragToColumn DragToColumn DragToColumn

Drag To Column.Represents the following attribute in the schema: dragToCol

DragToData DragToData DragToData

Field Can Drag to Data.Represents the following attribute in the schema: dragToData

DragToPage DragToPage DragToPage

Drag Field to Page.Represents the following attribute in the schema: dragToPage

DragToRow DragToRow DragToRow

Drag To Row.Represents the following attribute in the schema: dragToRow

ExtendedAttributes ExtendedAttributes ExtendedAttributes

Gets all extended attributes (attributes not defined in the schema) of the current element.

(Inherited from OpenXmlElement)
FirstChild FirstChild FirstChild

Gets the first child of the current OpenXmlElement element.

(Inherited from OpenXmlCompositeElement)
HasAttributes HasAttributes HasAttributes

Gets a boolean value that indicates whether the current element has any attributes.

(Inherited from OpenXmlElement)
HasChildren HasChildren HasChildren

Gets a value that indicates whether the current element has any child elements.

(Inherited from OpenXmlCompositeElement)
HiddenLevel HiddenLevel HiddenLevel

Hidden Level.Represents the following attribute in the schema: hiddenLevel

HideNewItems HideNewItems HideNewItems

Hide New Items.Represents the following attribute in the schema: hideNewItems

IncludeNewItemsInFilter IncludeNewItemsInFilter IncludeNewItemsInFilter

Inclusive Manual Filter.Represents the following attribute in the schema: includeNewItemsInFilter

InnerText InnerText InnerText

Gets or sets the concatenated values of the current node and all of its children.

(Inherited from OpenXmlCompositeElement)
InnerXml InnerXml InnerXml

Gets or sets the markup that represents only the child nodes of the current node.

(Inherited from OpenXmlCompositeElement)
InsertBlankRow InsertBlankRow InsertBlankRow

Insert Blank Row.Represents the following attribute in the schema: insertBlankRow

InsertPageBreak InsertPageBreak InsertPageBreak

Insert Item Page Break.Represents the following attribute in the schema: insertPageBreak

ItemPageCount ItemPageCount ItemPageCount

Items Per Page Count.Represents the following attribute in the schema: itemPageCount

Items Items Items

Field Items. Represents the following element tag in the schema: x:items

LastChild LastChild 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 LocalName LocalName

Gets the local name of the element.

MaxSubtotal MaxSubtotal MaxSubtotal

Max Subtotal.Represents the following attribute in the schema: maxSubtotal

MCAttributes MCAttributes MCAttributes

Sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element.

(Inherited from OpenXmlElement)
MeasureFilter MeasureFilter MeasureFilter

Measure Filter.Represents the following attribute in the schema: measureFilter

MinSubtotal MinSubtotal MinSubtotal

Min Subtotal.Represents the following attribute in the schema: minSubtotal

MultipleItemSelectionAllowed MultipleItemSelectionAllowed MultipleItemSelectionAllowed

Multiple Field Filters.Represents the following attribute in the schema: multipleItemSelectionAllowed

Name Name Name

Field Name.Represents the following attribute in the schema: name

NamespaceDeclarations NamespaceDeclarations 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 NamespaceUri NamespaceUri

Gets the namespace URI of the current element.

(Inherited from OpenXmlElement)
NonAutoSortDefault NonAutoSortDefault NonAutoSortDefault

Auto Sort.Represents the following attribute in the schema: nonAutoSortDefault

NumberFormatId NumberFormatId NumberFormatId

Number Format Id.Represents the following attribute in the schema: numFmtId

OpenXmlElementContext OpenXmlElementContext OpenXmlElementContext

Gets the OpenXmlEementContext of the current element.

(Inherited from OpenXmlElement)
OuterXml OuterXml OuterXml

Gets the markup that represents the current element and all of its child elements.

(Inherited from OpenXmlElement)
Outline Outline Outline

Outline Items.Represents the following attribute in the schema: outline

Parent Parent Parent

Gets the parent element of the current element.

(Inherited from OpenXmlElement)
PivotFieldExtensionList PivotFieldExtensionList PivotFieldExtensionList

Future Feature Data Storage Area. Represents the following element tag in the schema: x:extLst

Prefix Prefix Prefix

Gets the namespace prefix of current element.

(Inherited from OpenXmlElement)
RankBy RankBy RankBy

Auto Show Rank By.Represents the following attribute in the schema: rankBy

ServerField ServerField ServerField

Server-based Page Field.Represents the following attribute in the schema: serverField

ShowAll ShowAll ShowAll

Show All Items.Represents the following attribute in the schema: showAll

ShowDropDowns ShowDropDowns ShowDropDowns

Show PivotField Header Drop Downs.Represents the following attribute in the schema: showDropDowns

ShowPropAsCaption ShowPropAsCaption ShowPropAsCaption

Show As Caption.Represents the following attribute in the schema: showPropAsCaption

ShowPropCell ShowPropCell ShowPropCell

Show Member Property in Cell.Represents the following attribute in the schema: showPropCell

ShowPropertyTooltip ShowPropertyTooltip ShowPropertyTooltip

Show Member Property ToolTip.Represents the following attribute in the schema: showPropTip

SortType SortType SortType

Auto Sort Type.Represents the following attribute in the schema: sortType

SubtotalCaption SubtotalCaption SubtotalCaption

Custom Subtotal Caption.Represents the following attribute in the schema: subtotalCaption

SubtotalTop SubtotalTop SubtotalTop

Subtotals At Top.Represents the following attribute in the schema: subtotalTop

SumSubtotal SumSubtotal SumSubtotal

Sum Subtotal.Represents the following attribute in the schema: sumSubtotal

TopAutoShow TopAutoShow TopAutoShow

Top Auto Show.Represents the following attribute in the schema: topAutoShow

UniqueMemberProperty UniqueMemberProperty UniqueMemberProperty

Unique Member Property.Represents the following attribute in the schema: uniqueMemberProperty

XmlQualifiedName XmlQualifiedName XmlQualifiedName

Gets the qualified name of the current element.

(Inherited from OpenXmlElement)
XName XName XName

Gets the qualified name of the current element.

(Inherited from OpenXmlElement)

Methods

AddAnnotation(Object) AddAnnotation(Object) AddAnnotation(Object)

Adds an object to the current OpenXmlElement element's list of annotations.

(Inherited from OpenXmlElement)
AddNamespaceDeclaration(String, String) AddNamespaceDeclaration(String, String) AddNamespaceDeclaration(String, String)

Adds a namepace declaration to the current node.

(Inherited from OpenXmlElement)
Ancestors() Ancestors() Ancestors()

Enumerates all of the current element's ancestors.

(Inherited from OpenXmlElement)
Ancestors<T>() Ancestors<T>() Ancestors<T>()

Enumerates only the current element's ancestors that have the specified type.

(Inherited from OpenXmlElement)
Annotation(Type) Annotation(Type) Annotation(Type)

Get the first annotation object of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotation<T>() Annotation<T>() Annotation<T>()

Get the first annotation object of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotations(Type) Annotations(Type) Annotations(Type)

Gets a collection of annotations with the specified type for the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Annotations<T>() Annotations<T>() Annotations<T>()

Gets a collection of annotations with the specified type for the current OpenXmlElement element.

(Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>) Append(IEnumerable<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[]) Append(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) AppendChild<T>(T) AppendChild<T>(T)

Appends the specified element to the end of the current element's list of child nodes.

(Inherited from OpenXmlCompositeElement)
ClearAllAttributes() ClearAllAttributes() ClearAllAttributes()

Clears all of the attributes, including both known attributes and extended attributes.

(Inherited from OpenXmlElement)
Clone() Clone() Clone()

Creates a duplicate of the current node.

(Inherited from OpenXmlElement)
CloneNode(Boolean) CloneNode(Boolean) CloneNode(Boolean)

Creates a duplicate of this node.

Descendants() Descendants() Descendants()

Enumerates all of the current element's descendants.

(Inherited from OpenXmlElement)
Descendants<T>() Descendants<T>() Descendants<T>()

Enumerate all of the current element's descendants of type T.

(Inherited from OpenXmlElement)
Elements() Elements() Elements()

Enumerates all of the current element's children.

(Inherited from OpenXmlElement)
Elements<T>() Elements<T>() Elements<T>()

Enumerates only the current element's children that have the specified type.

(Inherited from OpenXmlElement)
ElementsAfter() ElementsAfter() 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() ElementsBefore() 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) GetAttribute(String, String) GetAttribute(String, String)

Gets an Open XML attribute with the specified tag name and namespace URI.

(Inherited from OpenXmlElement)
GetAttributes() GetAttributes() GetAttributes()

Gets a list that contains a copy of all the attributes.

(Inherited from OpenXmlElement)
GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the child collection.

(Inherited from OpenXmlElement)
GetFirstChild<T>() GetFirstChild<T>() GetFirstChild<T>()

Finds the first child element in type T.

(Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement) InsertAfter<T>(T, OpenXmlElement) InsertAfter<T>(T, OpenXmlElement)

Inserts the specified element immediately after the specified reference element.

(Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T) InsertAfterSelf<T>(T) InsertAfterSelf<T>(T)

Inserts the specified element immediately after the current element.

(Inherited from OpenXmlElement)
InsertAt<T>(T, Int32) InsertAt<T>(T, Int32) 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) InsertBefore<T>(T, OpenXmlElement) InsertBefore<T>(T, OpenXmlElement)

Inserts the specified element immediately before the specified reference element.

(Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T) InsertBeforeSelf<T>(T) InsertBeforeSelf<T>(T)

Inserts the specified element immediately before the current element.

(Inherited from OpenXmlElement)
IsAfter(OpenXmlElement) IsAfter(OpenXmlElement) IsAfter(OpenXmlElement)

Determines if the current element appears after a specified element in document order.

(Inherited from OpenXmlElement)
IsBefore(OpenXmlElement) IsBefore(OpenXmlElement) IsBefore(OpenXmlElement)

Determines if the current element appears before a specified element in document order.

(Inherited from OpenXmlElement)
LookupNamespace(String) LookupNamespace(String) LookupNamespace(String)

Resolves the namespace prefix in the context of the current node.

(Inherited from OpenXmlElement)
LookupPrefix(String) LookupPrefix(String) LookupPrefix(String)

Finds the corresponding prefix for a namespace uri in the current element scope.

(Inherited from OpenXmlElement)
NextSibling() NextSibling() 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>() NextSibling<T>() 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) PrependChild<T>(T) PrependChild<T>(T)

Inserts the specified element at the beginning of the current element's list of child nodes.

(Inherited from OpenXmlCompositeElement)
PreviousSibling() PreviousSibling() 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>() PreviousSibling<T>() 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() Remove() Remove()

Removes the current element from its parent.

(Inherited from OpenXmlElement)
RemoveAllChildren() RemoveAllChildren() RemoveAllChildren()

Removes all of the current element's child elements.

(Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>() RemoveAllChildren<T>() RemoveAllChildren<T>()

Remove all of the current element's child elements that are of type T.

(Inherited from OpenXmlElement)
RemoveAnnotations(Type) RemoveAnnotations(Type) RemoveAnnotations(Type)

Removes the annotations of the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
RemoveAnnotations<T>() RemoveAnnotations<T>() RemoveAnnotations<T>()

Removes the annotations with the specified type from the current OpenXmlElement element.

(Inherited from OpenXmlElement)
RemoveAttribute(String, String) RemoveAttribute(String, String) RemoveAttribute(String, String)

Removes the attribute from the current element.

(Inherited from OpenXmlElement)
RemoveChild<T>(T) RemoveChild<T>(T) RemoveChild<T>(T)

Removes the specified child element.

(Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String) RemoveNamespaceDeclaration(String) RemoveNamespaceDeclaration(String)

Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix.

(Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T) ReplaceChild<T>(OpenXmlElement, T) ReplaceChild<T>(OpenXmlElement, T)

Replaces one of the current element's child elements with another OpenXmlElement element.

(Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute) SetAttribute(OpenXmlAttribute) 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>) SetAttributes(IEnumerable<OpenXmlAttribute>) 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) WriteTo(XmlWriter) WriteTo(XmlWriter)

Saves the current node to the specified XmlWriter.

(Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() Inherited from OpenXmlElement

Applies to