ColumnView.FilterPopupExcelPrepareTemplate Event

Allows you to replace the UI for the Excel-styled menus’ “Values” tab. Also affects editors generated by the Filtering UI Context component attached to this Data Grid.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[DXCategory("Appearance")]
public event FilterPopupExcelPrepareTemplateEventHandler FilterPopupExcelPrepareTemplate

VB.NET

<DXCategory("Appearance")>
Public Event FilterPopupExcelPrepareTemplate As FilterPopupExcelPrepareTemplateEventHandler

Event Data

The FilterPopupExcelPrepareTemplate event's data class is DevExpress.XtraGrid.Views.Grid.FilterPopupExcelPrepareTemplateEventArgs.

Remarks

The FilterPopupExcelPrepareTemplate event allows you to change the items’ visual representation only. To modify the items themselves, handle the ColumnView.FilterPopupExcelData event instead.

In the example below, the FilterPopupExcelPrepareTemplate event replaces a default checked list box with a custom “TileList” control.

C#

using DevExpress.Utils.Filtering;
using DevExpress.Utils.Controls;

//replace the filtering UI template
private void GridView1_FilterPopupExcelPrepareTemplate(object sender, DevExpress.XtraGrid.Views.Grid.FilterPopupExcelPrepareTemplateEventArgs e) {
    if (e.PropertyPath == "CategoryID")
        e.Template = new TileList() { Images = categoryImages };
}

//a custom TileList control that replaces default check lists
public partial class TileList : XtraUserControl, IXtraResizableControl {
    public TileList() {
        InitializeComponent();
        Part_Values.CustomizeItem += PART_Values_CustomizeItem;
    }
    public SvgImageCollection Images {
        get;
        set;
    }
    public Size ImageSize {
        get { return new Size(Part_Values.ItemHeight - 8, Part_Values.ItemHeight - 8); }
        set { Part_Values.ItemHeight = Math.Max(40, value.Height + 8); }
    }
    protected override void OnParentChanged(System.EventArgs e) {
        base.OnParentChanged(e);
        if(Parent != null)
            Part_Values.BackColor = FindForm().BackColor;
    }
    void PART_Values_CustomizeItem(object sender, CustomizeTemplatedItemEventArgs e) {
        if(Images == null)
            return;
        var tileElement = e.TemplatedItem.Elements[0];
        if(e.Value is Enum) {
            tileElement.Image = Images.GetImage(e.Value.ToString().ToLowerInvariant(), ImageSize);
            return;
        }
        if(e.Value is int) {
            tileElement.Image = Images.GetImage((int)e.Value, ImageSize);
            return;
        }
        tileElement.Image = Images.GetImage("all", ImageSize);
    }
    Size IXtraResizableControl.MaxSize {
        get { return new Size(0, GetHeight()); }
    }
    Size IXtraResizableControl.MinSize {
        get { return new Size(0, GetHeight()); }
    }
    int GetHeight() {
        return (Part_Values.Items.Count > 0) ? Part_Values.CalcBestSize().Height : Part_Values.ItemHeight;
    }
}

VB.NET

Imports DevExpress.Utils.Filtering
Imports DevExpress.Utils.Controls

//replace the filtering UI template
Private Sub GridView1_FilterPopupExcelPrepareTemplate(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Grid.FilterPopupExcelPrepareTemplateEventArgs)
    If e.PropertyPath = "CategoryID" Then
        e.Template = New TileList() With {.Images = categoryImages}
    End If
End Sub

'a custom TileList control that replaces default check lists
Partial Public Class TileList
  Inherits XtraUserControl
  Implements IXtraResizableControl

    Public Sub New()
        InitializeComponent()
        AddHandler Part_Values.CustomizeItem, AddressOf PART_Values_CustomizeItem
    End Sub
    Public Property Images() As SvgImageCollection
    Public Property ImageSize() As Size
        Get
          Return New Size(Part_Values.ItemHeight - 8, Part_Values.ItemHeight - 8)
        End Get
        Set(ByVal value As Size)
          Part_Values.ItemHeight = Math.Max(40, value.Height + 8)
        End Set
    End Property
    Protected Overrides Sub OnParentChanged(ByVal e As System.EventArgs)
        MyBase.OnParentChanged(e)
        If Parent IsNot Nothing Then
            Part_Values.BackColor = FindForm().BackColor
        End If
    End Sub
    Private Sub PART_Values_CustomizeItem(ByVal sender As Object, ByVal e As CustomizeTemplatedItemEventArgs)
        If Images Is Nothing Then
            Return
        End If
        Dim tileElement = e.TemplatedItem.Elements(0)
        If TypeOf e.Value Is System.Enum Then
            tileElement.Image = Images.GetImage(e.Value.ToString().ToLowerInvariant(), ImageSize)
            Return
        End If
        If TypeOf e.Value Is Integer Then
            tileElement.Image = Images.GetImage(CInt(Math.Truncate(e.Value)), ImageSize)
            Return
        End If
        tileElement.Image = Images.GetImage("all", ImageSize)
    End Sub
    Private ReadOnly Property IXtraResizableControl_MaxSize() As Size Implements IXtraResizableControl.MaxSize
        Get
          Return New Size(0, GetHeight())
        End Get
    End Property
    Private ReadOnly Property IXtraResizableControl_MinSize() As Size Implements IXtraResizableControl.MinSize
        Get
          Return New Size(0, GetHeight())
        End Get
    End Property
    Private Function GetHeight() As Integer
        Return If(Part_Values.Items.Count > 0, Part_Values.CalcBestSize().Height, Part_Values.ItemHeight)
    End Function
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FilterPopupExcelPrepareTemplate 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#L28

gridControl1.DataSource = dataGenerator.CreateTable();
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#L26

gridControl1.DataSource = dataGenerator.CreateTable()
AddHandler gridView1.FilterPopupExcelPrepareTemplate, AddressOf GridView1_FilterPopupExcelPrepareTemplate
AddHandler gridView1.FilterPopupExcelCustomizeTemplate, AddressOf GridView1_FilterPopupExcelCustomizeTemplate