ASPxGridViewCustomCallbackEventArgs Class

Provides data for the ASPxGridView.CustomCallback event.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v19.2.dll

Declaration

C#

public class ASPxGridViewCustomCallbackEventArgs :
    ASPxGridCustomCallbackEventArgs

VB.NET

Public Class ASPxGridViewCustomCallbackEventArgs
    Inherits ASPxGridCustomCallbackEventArgs

Related API Members

ASPxGridViewCustomCallbackEventArgs is the data class for the following events:

• ASPxGridView.CustomCallback

Remarks

The ASPxGridView.CustomCallback event is raised when a round trip to the server has been initiated. This occurs when the client ASPxClientGridView.PerformCallback method is called.

The ASPxGridViewCustomCallbackEventArgs class provides the ASPxGridCustomCallbackEventArgs.Parameters property that specifies a string containing specific information passed from the client side. You can use this property to recognize different kinds of callbacks for performing various actions on the server side.

Example

C#

protected void Grid_CustomCallback(object sender, ASPxGridViewCustomCallbackEventArgs e) {
     if(e.Parameters == "ApplyCustomFilter")
          Grid.FilterExpression = "City = 'Bratislava'";
     if(e.Parameters == "ApplyCustomGrouping") { 
          Grid.DataColumns["City"].GroupBy();
          Grid.ExpandAll();
     }
}

VB.NET

Protected Sub Grid_CustomCallback(ByVal sender As Object, ByVal e As ASPxGridViewCustomCallbackEventArgs)
     If e.Parameters = "ApplyCustomFilter" Then
          Grid.FilterExpression = "City = 'Bratislava'"
     End If
     If e.Parameters = "ApplyCustomGrouping" Then
          Grid.DataColumns("City").GroupBy()
          Grid.ExpandAll()
     End If
End Sub

ASPX

<script type="text/javascript">
     function onApplyFilterButtonClick(s, e) {
          grid.PerformCallback("ApplyCustomFilter");
     }
     function onApplyGroupingButtonClick(s, e) {
          grid.PerformCallback("ApplyCustomGrouping");
     }
</script>
…

<dx:ASPxGridView ID="Grid" runat="server" KeyFieldName="ID" ClientInstanceName="grid" OnCustomCallback="Grid_CustomCallback">
     <Columns>
          <dx:GridViewDataColumn FieldName="ID" />
          <dx:GridViewDataColumn FieldName="FirstName" />
          <dx:GridViewDataColumn FieldName="LastName" />
          <dx:GridViewDataColumn FieldName="City" />
     </Columns>
</dx:ASPxGridView>

<dx:ASPxButton ID="ApplyFilterButton" runat="server" AutoPostBack="false" UseSubmitBehavior="false" Text="Apply Custom Filter">
     <ClientSideEvents Click="onApplyFilterButtonClick" />
</dx:ASPxButton>

<dx:ASPxButton ID="ApplyGroupingButton" runat="server" AutoPostBack="false" UseSubmitBehavior="false" Text="Apply Custom Grouping">
     <ClientSideEvents Click="onApplyGroupingButtonClick" />
</dx:ASPxButton>

Related GitHub Examples

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

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.

VB.NET

aspxgridview-batch-mode-how-to-submit-changes-and-aspxformlayouts-values-at-once-t510345/VB/T510345_VB/Default.aspx.vb#L29

Protected Sub ASPxGridView1_CustomCallback(sender As Object, e As ASPxGridViewCustomCallbackEventArgs)
    GetFormValues()

Inheritance

Object

EventArgs

ASPxGridCustomCallbackEventArgs

ASPxGridViewCustomCallbackEventArgs