QueryBuilderClientSideEventsBuilder Class

Use the class methods to specify handlers for the Web Query Builder‘s client-side events.

Namespace: DevExpress.AspNetCore.Reporting.QueryBuilder

Assembly: DevExpress.AspNetCore.Reporting.v21.1.dll

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public class QueryBuilderClientSideEventsBuilder

VB.NET

Public Class QueryBuilderClientSideEventsBuilder

Related API Members

The following members return QueryBuilderClientSideEventsBuilder objects:

• QueryBuilderClientSideEventsBuilder.BeforeRender(String)
• QueryBuilderClientSideEventsBuilder.CustomizeLocalization(String)
• QueryBuilderClientSideEventsBuilder.CustomizeMenuActions(String)
• QueryBuilderClientSideEventsBuilder.OnServerError(String)
• QueryBuilderClientSideEventsBuilder.SaveQueryRequested(String)

Remarks

The QueryBuilderClientSideEventsBuilder class exposes methods whose names resemble client-side events of the Web Query Builder. Use method’s parameter to pass an event handler.

To use the QueryBuilderClientSideEventsBuilder methods, call the QueryBuilderHtmlContentBuilder.ClientSideEvents method that returns the QueryBuilderClientSideEventsBuilder instance.

The following code demonstrates how to handle the Web Query Builder’s CustomizeMenuActions client-side event:

CSHTML

@{ var queryBuilder = Html.DevExpress().QueryBuilder("webQueryBuilder")
                    .Height("400px")
                    .Bind(Model)
                    .ClientSideEvents(configure =>
                    { configure.CustomizeMenuActions("customizeMenuActions"); }); ; }
@queryBuilder

JavaScript

<script>
    function customizeMenuActions(s, e) {
        // Get the "Save" action and hide it.
        var saveAction = e.GetById(DevExpress.QueryBuilder.Utils.ActionId.Save);
        if (saveAction)
            saveAction.visible = false;
    }
</script>

Inheritance

Object

QueryBuilderClientSideEventsBuilder