PivotGridCustomTotal.Format Property

Gets or sets the string used to format the text within the custom total headers.

Namespace: DevExpress.Xpf.PivotGrid

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

NuGet Packages: DevExpress.WindowsDesktop.Wpf.PivotGrid, DevExpress.Wpf.PivotGrid

Declaration

C#

public string Format { get; set; }

VB.NET

Public Property Format As String

Property Value

Type	Description
String	A string used to format the content of the custom total headers.

Remarks

By default, the caption displayed within the custom total’s header is formatted using the following pattern: {0} SummaryType where ‘{0}’ is replaced with the corresponding value of the column/row field and the ‘SummaryType’ identifies the summary function type (e.g. “Beverages Sum”, “Beverages Average”, etc).

The Format property allows you to override the default format settings.

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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Format 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.

C#

how-to-calculate-multiple-custom-totals-with-summarytype-set-to-custom-e3822/CS/DXPivotGrid_MultipleCustomTotals/MainWindow.xaml.cs#L26

// Custom Total column/row headers.
medianCustomTotal.Format = "{0} Median";