PivotGridField.CellFormat Property

Gets or sets the string used to format the cells. This is a dependency property.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v23.2.dll

NuGet Package: DevExpress.Wpf.PivotGrid

Declaration

C#

public string CellFormat { get; set; }

VB.NET

Public Property CellFormat As String

Property Value

Type	Description
String	A string used to format the cells.

Remarks

This property allows you to format values using the format strings described in the Standard Numeric Format Strings, Custom Numeric Format Strings, Standard Date and Time Format Strings and Custom Date and Time Format Strings topics in MSDN.

To learn more, see Standard Formatting.

Example

The following example shows how to format Order Date field values and summaries corresponding to the Extended Price field. Order Date field values are formatted using a long date pattern while Extended Price summaries are formatted as integer currency values.

The result of the code is shown below:

XAML

<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField Area="DataArea" FieldName="Extended_Price" CellFormat="c0"/>
    <dxpg:PivotGridField Area="RowArea" FieldName="OrderDate" GroupInterval="Date" ValueFormat="D"/>
    <dxpg:PivotGridField Area="ColumnArea" FieldName="Country"/>  
</dxpg:PivotGridControl.Fields>

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CellFormat property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-pivotgrid-hide-column-totals/CS/HowToBindToMDB/MainWindow.xaml#L22

</dxpg:PivotGridField>
<dxpg:PivotGridField Name="fieldUnitPrice"  Area="DataArea" CellFormat="c2">
    <dxpg:PivotGridField.DataBinding>

wpf-pivot-custom-group-intervals/CS/HowToCustomGroupInterval/MainWindow.xaml#L17

    <dxpg:PivotGridField Name="fieldExtendedPrice" FieldName="Extended Price"
                         Area="DataArea" CellFormat="c0" />
</dxpg:PivotGridControl.Fields>

pivotgridcontrol-and-gaugecontrol-integration-e3332/CS/PivotGauges/MainWindow.xaml#L34

<dxpg:PivotGridField Area="ColumnArea" Caption="Year" FieldName="ShippedDate" GroupInterval="DateYear" />
<dxpg:PivotGridField Area="DataArea" Caption="Sales" FieldName="Price" CellFormat="C" />
<dxpg:PivotGridField Caption="Employee" FieldName="EmployeeName" />

wpf-pivot-grid-obtain-underlying-data/CS/ObtainUnderlyingData/MainWindow.xaml#L102

Area="DataArea"
CellFormat="c0"
Name="fieldExtendedPrice" >

wpf-pivot-grid-create-field-value-template/CS/HowToCreateFieldValueTemplate/MainWindow.xaml#L42

</dxpg:PivotGridField>
<dxpg:PivotGridField Name="fieldExtendedPrice" Area="DataArea" CellFormat="c0" >
    <dxpg:PivotGridField.DataBinding>

VB.NET

wpf-pivot-grid-connect-to-an-access-database-in-code/VB/HowToBindToMDB/MainWindow.xaml.vb#L45

' Specify the formatting setting to format summary values as integer currency amount.
fieldExtendedPrice.CellFormat = "c0"
' Add the fields to the control's field collection.