PivotGridControl.FormatConditions Property

Gets the collection of style format conditions.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.2.dll

Declaration

C#

[XtraSerializableProperty(XtraSerializationVisibility.Collection, true, false, true, 1000, XtraSerializationFlags.DefaultValue)]
[XtraSerializablePropertyId(1)]
[Browsable(false)]
public PivotGridFormatConditionCollection FormatConditions { get; }

VB.NET

<XtraSerializableProperty(XtraSerializationVisibility.Collection, True, False, True, 1000, XtraSerializationFlags.DefaultValue)>
<XtraSerializablePropertyId(1)>
<Browsable(False)>
Public ReadOnly Property FormatConditions As PivotGridFormatConditionCollection

Property Value

Type	Description
PivotGridFormatConditionCollection	The collection of style format conditions.

Remarks

The FormatConditions property supports legacy style format conditions. Instead of this feature, we suggest that you use the advanced conditional format rules to highlight cells matching your criteria. These format rules can be created with the PivotGridControl.FormatRules property.

Note

Note that the PivotGridControl.CustomCellValue event does not affect format conditions defined using the FormatConditions property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FormatConditions 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-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/CS/PivotGridFormatCondition/ExpressionConditionDesigner.cs#L31

listBoxControlExpressions.Items.Clear();
foreach (PivotGridStyleFormatCondition item in SourcePivot.FormatConditions)
{

how-to-conditionally-format-the-style-of-pivot-grid-cells-e2312/CS/Form1.cs#L93

void SetCondition(PivotGridControl pivot, string expression, PivotGridField field) {
    PivotGridFormatConditionCollection conditions = pivot.FormatConditions;
    PivotGridStyleFormatCondition condition = new PivotGridStyleFormatCondition();

VB.NET

how-to-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/VB/PivotGridFormatCondition/ExpressionConditionDesigner.vb#L44

listBoxControlExpressions.Items.Clear()
For Each item As PivotGridStyleFormatCondition In SourcePivot.FormatConditions
    If item.Field.Name = SourceField.Name AndAlso item.Condition = FormatConditionEnum.Expression Then

how-to-conditionally-format-the-style-of-pivot-grid-cells-e2312/VB/Form1.vb#L92

Private Sub SetCondition(ByVal pivot As PivotGridControl, ByVal expression As String, ByVal field As PivotGridField)
    Dim conditions As PivotGridFormatConditionCollection = pivot.FormatConditions
    Dim condition As New PivotGridStyleFormatCondition()