DataField Class

Definition

Namespace:

DocumentFormat.OpenXml.Office2010.Excel

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the DataField Class.

This class is available in Office 2010 and above.

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

public class DataField : DocumentFormat.OpenXml.OpenXmlLeafElement

type DataField = class
    inherit OpenXmlLeafElement

Public Class DataField
Inherits OpenXmlLeafElement

Inheritance

Object

OpenXmlElement

OpenXmlLeafElement

DataField

Remarks

2.4.17 dataField

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

A dataField element is a CT_DataField type element, as specified in section 2.6.25, that specifies extended information about a PivotTable, as specified in [ISO/IEC-29500-1] section 18.10, data field (1) item. See section 2.2.4.4 for how this element integrates with the Office Open XML file formats specified in [ISO/IEC-29500-1].

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="dataField" type="CT_DataField"/>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.6.25 CT_DataField

Target namespace: http://schemas.microsoft.com/office/spreadsheetml/2009/9/main

Referenced by: dataField

This complex type specifies extended information about a PivotTable ([ISO/IEC-29500-1] section 18.10) data field (1) item ([ISO/IEC-29500-1] section 18.10.1.22).

Attributes:

pivotShowAs: An ST_PivotShowAs attribute that specifies the data display format for this PivotTable ([ISO/IEC-29500-1] section 18.10) data field (1) item. If this attribute is specified, the showDataAs attribute of the ancestor CT_Datafield ([ISO/IEC-29500-4] section A.2) element MUST NOT be specified. If this attribute is equal to "percentOfParent", "percentOfRunningTotal", "rankAscending", or "rankDescending", the baseField attribute of the ancestor CT_Datafield ([ISO/IEC-29500-4] section A.2) element MUST be greater than or equal to 0.

sourceField: An unsignedInt ([XMLSCHEMA2] section 3.3.22) attribute that specifies the zero-based index of the CT_PivotField ([ISO/IEC-29500-4] section A.2) element in the list of CT_PivotField ([ISO/IEC-29500-4] section A.2) elements specified by the CT_PivotFields ([ISO/IEC-29500-4] section A.2) element that this data item summarizes.

If an OLAP measure is summarized in a PivotTable ([ISO/IEC-29500-1] section 18.10) as a data field (1) item ([ISO/IEC-29500-1] section 18.10.1.22) more than one time, data field (1) items ([ISO/IEC-29500-1] section 18.10.1.22) that specify that OLAP measure after the first data field (1) item ([ISO/IEC-29500-1] section 18.10.1.22) that specifies that OLAP measure MUST have a descendant CT_DataField element with a sourceField specified.

If this attribute is specified, the CT_PivotField ([ISO/IEC-29500-4] section A.2) element specified by the fld attribute of the ancestor CT_Datafield ([ISO/IEC-29500-4] section A.2) element MUST have a descendant CT_PivotField element with an ignore attribute equal to "true".

If this attribute is specified, the CT_CacheField ([ISO/IEC-29500-4] section A.2) element with a zero-based index in the list of CT_CacheField ([ISO/IEC-29500-4] section A.2) elements specified by the CT_CacheFields ([ISO/IEC-29500-4] section A.2) element equal to the fld attribute of the ancestor CT_Datafield ([ISO/IEC-29500-4] section A.2) element that exists in the Pivot Table Cache Definition part ([ISO/IEC-29500-1] section 12.3.12) specified by the cacheId attribute of the CT_PivotTableDefinition ([ISO/IEC-29500-4] section A.2) element that is the ancestor of this element MUST have a descendant CT_CacheField element. The CT_CacheHierarchy ([ISO/IEC-29500-4] section A.2) element specified by the hierarchy attribute of that CT_CacheField ([ISO/IEC-29500-4] section A.2) element MUST have a descendent CT_CacheHierarchy element with an ignore attribute equal to "true". The CT_PivotHierarchy ([ISO/IEC-29500-4] section A.2) element with a zero-based index in the list of CT_PivotHierarchy ([ISO/IEC-29500-4] section A.2) elements specified by the CT_PivotHierarchies ([ISO/IEC-29500-4] section A.2) element in this part that is equal to the zero-based index of that CT_CacheHierarchy ([ISO/IEC-29500-4] section A.2) element in the list of CT_CacheHierarchy ([ISO/IEC-29500-4] section A.2) elements specified by the CT_CacheHierarchies ([ISO/IEC-29500-4] section A.2) element MUST have a descendant CT_PivotHierarchy element.

If this attribute is specified, the fld attribute of the ancestor CT_Datafield ([ISO/IEC-29500-4] section A.2) element SHOULD<48> be ignored.

This attribute MUST NOT be specified for non-OLAP PivotTables ([ISO/IEC-29500-1] section 18.10).

uniqueName: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the unique name for duplicated OLAP measures. MUST be unique within this part. MUST be less than or equal to 65,535 characters in length.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_DataField">

<xsd:attribute name="pivotShowAs" type="ST_PivotShowAs" use="optional"/>

<xsd:attribute name="sourceField" type="xsd:unsignedInt" use="optional"/>

<xsd:attribute name="uniqueName" type="x:ST_Xstring" use="optional"/>

</xsd:complexType>

See section 5.4 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

Constructors

DataField()

Initializes a new instance of the DataField class.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
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 OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
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 OpenXmlLeafElement)
InnerText	Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement)
InnerXml	Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement)
LastChild	Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
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)
PivotShowAs	pivotShowAs, this property is only available in Office 2010 and later. Represents the following attribute in the schema: pivotShowAs
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
SourceField	sourceField, this property is only available in Office 2010 and later. Represents the following attribute in the schema: sourceField
UniqueName	uniqueName, this property is only available in Office 2010 and later. Represents the following attribute in the schema: uniqueName
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)
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 OpenXmlElement)
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 OpenXmlElement)
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 in the current element's list of child elements. (Inherited from OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement)
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 elements. (Inherited from OpenXmlElement)
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 child elements of the current element. (Inherited from OpenXmlLeafElement)
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 from the current element's list of child elements. (Inherited from OpenXmlElement)
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 a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement)
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)