PivotField Class

PivotTable Field.

This class is available in Office 2007 and above.

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

Inheritance Hierarchy

SystemObject
  DocumentFormat.OpenXmlOpenXmlElement
    DocumentFormat.OpenXmlOpenXmlCompositeElement
      TypedOpenXmlCompositeElement
        DocumentFormat.OpenXml.SpreadsheetPivotField

Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll) Version: 2.20.0+Branch.release-v2.20.0.Sha.a873d3fbff9bffe179fea62486da950adf5be65d.a873d3fbff9bffe179fea62486da950adf5be65d

Syntax

C++

Copy

public class PivotField : TypedOpenXmlCompositeElement

Public Class PivotField
	Inherits TypedOpenXmlCompositeElement

public ref class PivotField : public TypedOpenXmlCompositeElement

type PivotField = 
    class
        inherit TypedOpenXmlCompositeElement
    end

The PivotField type exposes the following members.

Constructors

	Name	Description
	PivotField	Initializes a new instance of the PivotField class.
	PivotField(IEnumerableOpenXmlElement)	Initializes a new instance of the PivotField class with the specified child elements.
	PivotField(OpenXmlElement)	Initializes a new instance of the PivotField class with the specified child elements.
	PivotField(String)	Initializes a new instance of the PivotField class from outer XML.

Top

Properties

	Name	Description
	AllDrilled	All Items Expanded Represents the following attribute in the schema: allDrilled
	ApplyProductInSubtotal	Product Subtotal Represents the following attribute in the schema: productSubtotal
	ApplyStandardDeviationInSubtotal	StdDev Subtotal Represents the following attribute in the schema: stdDevSubtotal
	ApplyStandardDeviationPInSubtotal	StdDevP Subtotal Represents the following attribute in the schema: stdDevPSubtotal
	ApplyVarianceInSubtotal	Variance Subtotal Represents the following attribute in the schema: varSubtotal
	ApplyVariancePInSubtotal	VarP Subtotal Represents the following attribute in the schema: varPSubtotal
	AutoShow	Auto Show Represents the following attribute in the schema: autoShow
	AutoSortScope	AutoSort Scope. Represents the following element tag in the schema: x:autoSortScope.
	AverageSubTotal	Average Represents the following attribute in the schema: avgSubtotal
	Axis	Axis Represents the following attribute in the schema: axis
	ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
	Compact	Compact Represents the following attribute in the schema: compact
	CountASubtotal	CountA Represents the following attribute in the schema: countASubtotal
	CountSubtotal	Count Represents the following attribute in the schema: countSubtotal
	DataField	Data Field Represents the following attribute in the schema: dataField
	DataSourceSort	Data Source Sort Represents the following attribute in the schema: dataSourceSort
	DefaultAttributeDrillState	Drill State Represents the following attribute in the schema: defaultAttributeDrillState
	DefaultSubtotal	Show Default Subtotal Represents the following attribute in the schema: defaultSubtotal
	DragOff	Drag Off Represents the following attribute in the schema: dragOff
	DragToColumn	Drag To Column Represents the following attribute in the schema: dragToCol
	DragToData	Field Can Drag to Data Represents the following attribute in the schema: dragToData
	DragToPage	Drag Field to Page Represents the following attribute in the schema: dragToPage
	DragToRow	Drag To Row Represents the following attribute in the schema: dragToRow
	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 indicating whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
	HiddenLevel	Hidden Level Represents the following attribute in the schema: hiddenLevel
	HideNewItems	Hide New Items Represents the following attribute in the schema: hideNewItems
	IncludeNewItemsInFilter	Inclusive Manual Filter Represents the following attribute in the schema: includeNewItemsInFilter
	InnerText	Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlCompositeElement)
	InnerXml	Gets or sets the markup that represents only the child elements of the current element. (Inherited from OpenXmlCompositeElement)
	InsertBlankRow	Insert Blank Row Represents the following attribute in the schema: insertBlankRow
	InsertPageBreak	Insert Item Page Break Represents the following attribute in the schema: insertPageBreak
	ItemPageCount	Items Per Page Count Represents the following attribute in the schema: itemPageCount
	Items	Field Items. Represents the following element tag in the schema: x:items.
	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	Max Subtotal 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)
	MeasureFilter	Measure Filter Represents the following attribute in the schema: measureFilter
	MinSubtotal	Min Subtotal Represents the following attribute in the schema: minSubtotal
	MultipleItemSelectionAllowed	Multiple Field Filters Represents the following attribute in the schema: multipleItemSelectionAllowed
	Name	Field Name Represents the following attribute in the schema: name
	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)
	NonAutoSortDefault	Auto Sort Represents the following attribute in the schema: nonAutoSortDefault
	NumberFormatId	Number Format Id Represents the following attribute in the schema: numFmtId
	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 Items Represents the following attribute in the schema: outline
	Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
	PivotFieldExtensionList	Future Feature Data Storage Area. Represents the following element tag in the schema: x:extLst.
	Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
	RankBy	Auto Show Rank By Represents the following attribute in the schema: rankBy
	ServerField	Server-based Page Field Represents the following attribute in the schema: serverField
	ShowAll	Show All Items Represents the following attribute in the schema: showAll
	ShowDropDowns	Show PivotField Header Drop Downs Represents the following attribute in the schema: showDropDowns
	ShowPropAsCaption	Show As Caption Represents the following attribute in the schema: showPropAsCaption
	ShowPropCell	Show Member Property in Cell Represents the following attribute in the schema: showPropCell
	ShowPropertyTooltip	Show Member Property ToolTip Represents the following attribute in the schema: showPropTip
	SortType	Auto Sort Type Represents the following attribute in the schema: sortType
	SubtotalCaption	Custom Subtotal Caption Represents the following attribute in the schema: subtotalCaption
	SubtotalTop	Subtotals At Top Represents the following attribute in the schema: subtotalTop
	SumSubtotal	Sum Subtotal Represents the following attribute in the schema: sumSubtotal
	TopAutoShow	Top Auto Show Represents the following attribute in the schema: topAutoShow
	UniqueMemberProperty	Unique Member Property Represents the following attribute in the schema: uniqueMemberProperty
	XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
	XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Top

Methods

	Name	Description
	AddAnnotation	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
	AddChild	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	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
	Ancestors	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
	Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
	AnnotationT	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)
	AnnotationsT	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
	Append(IEnumerableOpenXmlElement)	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)
	AppendChildT	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	When overridden in a derived class, creates a duplicate of the node. (Overrides OpenXmlElementCloneNode(Boolean))
	DescendantsT	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
	ElementsT	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)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAttribute	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)
	GetFirstChildT	Finds the first child element in type T. (Inherited from OpenXmlElement)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	InsertAfterT	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
	InsertAfterSelfT	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
	InsertAtT	Inserts the specified element at the specified index in the current element's list of child elements. (Inherited from OpenXmlCompositeElement)
	InsertBeforeT	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
	InsertBeforeSelfT	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
	IsAfter	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
	IsBefore	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
	LookupNamespace	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
	LookupPrefix	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)
	PrependChildT	Inserts the specified element at the beginning of the current element's list of child elements. (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)
	Remove	Removes the current element from its parent. (Inherited from OpenXmlElement)
	RemoveAllChildren	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
	RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
	RemoveAnnotationsT	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
	RemoveAttribute	Removes the attribute from the current element. (Inherited from OpenXmlElement)
	RemoveChildT	Removes the specified child element from the current element's list of child elements. (Inherited from OpenXmlCompositeElement)
	RemoveNamespaceDeclaration	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
	ReplaceChildT	Replaces a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlCompositeElement)
	SetAttribute	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	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)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	WriteTo	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Top

Reference

DocumentFormat.OpenXml.Spreadsheet Namespace