ColumnView.FilterPopupExcelCustomizeTemplate Event

Allows you to customize templates for Excel-style filters and for external editors generated with Filtering UI Context.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[DXCategory("Appearance")]
public event FilterPopupExcelCustomizeTemplateEventHandler FilterPopupExcelCustomizeTemplate

VB.NET

<DXCategory("Appearance")>
Public Event FilterPopupExcelCustomizeTemplate As FilterPopupExcelCustomizeTemplateEventHandler

Event Data

The FilterPopupExcelCustomizeTemplate event's data class is DevExpress.XtraGrid.Views.Grid.FilterPopupExcelCustomizeTemplateEventArgs.

Remarks

The FilterPopupExcelCustomizeTemplate event is raised each time a user invokes an Excel-style filter and allows you to customize its template.

The code sample below illustrates how to change the background color in an Excel-style filter.

C#

gridView1.FilterPopupExcelCustomizeTemplate += OnFilterPopupExcelCustomizeTemplate;

void OnFilterPopupExcelCustomizeTemplate(object sender, FilterPopupExcelCustomizeTemplateEventArgs e)
{
    e.Template.BackColor = System.Drawing.Color.FromArgb(0, 0, 120);
}

VB.NET

Private gridView1.FilterPopupExcelCustomizeTemplate += AddressOf OnFilterPopupExcelCustomizeTemplate

Private Sub OnFilterPopupExcelCustomizeTemplate(ByVal sender As Object, ByVal e As FilterPopupExcelCustomizeTemplateEventArgs)
    e.Template.BackColor = System.Drawing.Color.FromArgb(0, 0, 120)
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FilterPopupExcelCustomizeTemplate event.

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-create-a-custom-template-for-the-excel-column-filter-drop-down-window-t591683/CS/T591683/MainForm.cs#L29

    gridView1.FilterPopupExcelPrepareTemplate += GridView1_FilterPopupExcelPrepareTemplate;
    gridView1.FilterPopupExcelCustomizeTemplate += GridView1_FilterPopupExcelCustomizeTemplate;
}

VB.NET

how-to-create-a-custom-template-for-the-excel-column-filter-drop-down-window-t591683/VB/T591683/MainForm.vb#L27

    AddHandler gridView1.FilterPopupExcelPrepareTemplate, AddressOf GridView1_FilterPopupExcelPrepareTemplate
    AddHandler gridView1.FilterPopupExcelCustomizeTemplate, AddressOf GridView1_FilterPopupExcelCustomizeTemplate
End Sub