PivotGridFieldBase.IsDefaultFormat(FormatInfo) Method

Returns whether the specified formatting settings match the default ones.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v24.2.Core.dll

Declaration

C#

public static bool IsDefaultFormat(
    FormatInfo formatInfo
)

VB.NET

Public Shared Function IsDefaultFormat(
    formatInfo As FormatInfo
) As Boolean

Parameters

Name	Type	Description
formatInfo	FormatInfo	A FormatInfo object that represents the formatting settings that should be compared with the default ones.

Returns

Type	Description
Boolean	true if the specified formatting settings match the default ones; otherwise, false.

Remarks

The PivotGridControl provides global default formatting settings for date/time, decimal and percent values. These settings are accessed via the static PivotGridFieldBase.DefaultDateFormat, PivotGridFieldBase.DefaultDecimalFormat, and PivotGridFieldBase.DefaultPercentFormat properties, respectively. The total values have specific global formatting settings obtained by the static PivotGridFieldBase.DefaultTotalFormat property. The IsDefaultFormat method returns true if the specified formatting settings match the default ones for one of the value types.