Format Class

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

Inheritance Hierarchy


Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)


<ChildElementInfoAttribute(GetType(PivotArea))> _
<ChildElementInfoAttribute(GetType(ExtensionList))> _
Public Class Format _
    Inherits OpenXmlCompositeElement
Dim instance As Format
public class Format : OpenXmlCompositeElement


The following table lists the possible child types:

  • PivotArea <x:pivotArea>

  • ExtensionList <x:extLst>

[ISO/IEC 29500-1 1st Edition] format (PivotTable Format)

Represents the format defined in the PivotTable.

Parent Elements

formats (§

Child Elements


extLst (Future Feature Data Storage Area)


pivotArea (Pivot Area)




action (Format Action)

Specifies the formatting behavior for the area indicated in the pivotArea element. The default value for this attribute is "formatting," which indicates that the specified cells have some formatting applied. The format is specified in the dxfId attribute. If the formatting is cleared from the cells, then the value of this attribute becomes "blank."

The possible values for this attribute are defined by the ST_FormatAction simple type (§18.18.34).

dxfId (Format Id)

Specifies the identifier of the format the application is currently using for the PivotTable. Formatting information is written to the styles part. See the Styles section (§18.8) for more information on 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_DxfId simple type (§18.18.25).

[Note: The W3C XML Schema definition of this element’s content model (CT_Format) 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.

See Also


Format Members

DocumentFormat.OpenXml.Spreadsheet Namespace