Skip to main content

ColumnView.FilterEditorCreated Event

Allows you to customize the Filter Editor before it is displayed on screen.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v22.2.dll

NuGet Package: DevExpress.Win.Grid

Declaration

[DXCategory("Behavior")]
public event FilterControlEventHandler FilterEditorCreated

Event Data

The FilterEditorCreated event's data class is FilterControlEventArgs. The following properties provide information specific to this event:

Property Description
Context Provides access to the ExpressionEditorContext object, which allows you to customize the FilterEditorControl‘s “Text” tab. Inherited from BaseFilterControlEventArgs.
FilterBuilder Gets the form that displays the Filter Control.
FilterControl Gets the Filter Control that displays filter criteria. This property returns null if the ColumnViewOptionsFilter.DefaultFilterEditorView property is set to any value except Visual.
FilterEditor Gets the FilterControl (in Visual view mode) or embedded FilterControl (in VisualText, TextVisual and Text view modes). Inherited from BaseFilterControlEventArgs.
FilterEditorForm Inherited from BaseFilterControlEventArgs.
IFilterControl Gets the Filter Control that displays filter criteria.
IFilterEditor Provides access to the currently used Filter Control (FilterControl or FilterEditorControl) via an interface. Inherited from BaseFilterControlEventArgs.
ShowFilterEditor Gets or sets whether to display the Filter Editor (the form that embeds the Filter Editor). Inherited from BaseFilterControlEventArgs.

Remarks

Use the FilterEditorCreated event to customize the Filter Editor, or prevent it from being displayed. The event fires each time the Filter Editor is to be displayed on screen.

Example

This example handles the FilterControl.CustomValueEditor event to assign custom editors (Spin Editor and Calc Editor) to value operands in Data Grid’s embedded FilterControl.

The Data Grid’s ColumnView.FilterEditorCreated event is used to subscribe to the FilterControl.CustomValueEditor event.

FilterControl-CustomValueEditor

View Example

private void gridView1_FilterEditorCreated(object sender, FilterControlEventArgs e) {
    e.FilterEditor.CustomValueEditor += FilterEditor_CustomValueEditor;
}

readonly RepositoryItemSpinEdit spinEdit = new RepositoryItemSpinEdit();
readonly RepositoryItemCalcEdit calcEdit = new RepositoryItemCalcEdit();

private void FilterEditor_CustomValueEditor(object sender, CustomValueEditorArgs e) {
    if (e.Node.FirstOperand.PropertyName != "Payment") return;
    RepositoryItemTextEdit item = null;
    if (e.ElementIndex == 2)
        item = spinEdit;
    else
        item = calcEdit;
    var settings = item.MaskSettings.Configure<MaskSettings.Numeric>();
    settings.MaskExpression = "c";
    e.RepositoryItem = item;
}
See Also