Export (0) Print
Expand All

DataField class

Defines the DataField Class.This class is available in Office2010 or above. When the object is serialized out as xml, its qualified name is x14:dataField.

Namespace:  DocumentFormat.OpenXml.Office2010.Excel
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class DataField : OpenXmlLeafElement

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).

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

Show:
© 2014 Microsoft