How to: Create Custom Command Buttons

• Sep 30, 2021

This example shows how to create and customize a custom command button.

To create and customize a button at design-time, invoke the ASPxGridView Designer, select Columns > # (the command column) from the Columns list, and then click the ellipsis button next to the CustomButtons property. This property manages the GridViewCommandColumn.CustomButtons collection.

You should specify the button’s identifier, text, and the row(s) in which the custom button is displayed. In this example, the ‘Apply Default Filter’ button is created and displayed within the auto filter row.

Handle the ASPxGridView.CustomButtonCallback event to define an action for the custom button.

C#

using DevExpress.Web.ASPxGridView;

protected void ASPxGridView1_CustomButtonCallback
(object sender, ASPxGridViewCustomButtonCallbackEventArgs e) {
    if (e.ButtonID != "cbFilter") return;
    ASPxGridView grid = sender as ASPxGridView;
    grid.FilterExpression = "[Title] like '%Sales%'";
}

VB.NET

Protected Sub ASPxGridView1_CustomButtonCallback(ByVal sender As Object, ByVal e As ASPxGridViewCustomButtonCallbackEventArgs)
    If e.ButtonID <> "cbFilter" Then Return
    Dim grid As ASPxGridView = TryCast(sender, ASPxGridView)
    grid.FilterExpression = "[Title] like '%Sales%'"
End Sub