PivotGridCustomTotalBase.Format Property

Provides the settings used to format the text within the custom total's headers.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v20.1.Core.dll

Declaration

public FormatInfo Format { get; }
Public ReadOnly Property Format As FormatInfo

Property Value

Type Description
FormatInfo

A FormatInfo object that specifies formatting settings for the text displayed within the custom total's header.

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 formatting settings.

The settings provided by this property allow you to format values using two approaches. The first is to use the format strings described in the Standard Numeric Format Strings, Custom Numeric Format Strings, Standard Date and Time Format Strings, Custom Date and Time Format Strings and Composite Formatting topics in MSDN. Another approach is to implement a custom formatter object. This enables you to apply formatting of any desired level of complexity.

Refer to Data Formatting to learn more.

See Also