PivotGridFieldOptionsEx.ShowInFilter Property

Gets or sets whether the field is available for selection in the Filter Editor.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.2.dll

Declaration

[DefaultValue(true)]
[XtraSerializableProperty]
public bool ShowInFilter { get; set; }
<DefaultValue(True)>
<XtraSerializableProperty>
Public Property ShowInFilter As Boolean

Property Value

Type Default Description
Boolean

true

True if the field is available in the Filter Editor; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type Path to ShowInFilter
PivotGridField
.Options.ShowInFilter

Remarks

If the ShowInFilter property is set to false, the field is not displayed in the drop-down filed list invoked in the Filter Editor, as the Category Name field in the picture below...

FilterEditor_ShowInFilter

... and the Filter editor does not recognize the field's name:

FilterEditor_ShowInFilter_Invalid

It may prevent end-users from using the current field when constructing filter criteria. However, if the Filter Editor edits the criteria already containing that field, the field is available despite the ShowInFilter property setting.

TIP

You can also prevent end-users from displaying the filter drop-down list by setting the PivotGridFieldOptions.AllowFilter field's property to false.

See Also