Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

ReportDesignerClientSideEventsBuilder.ReportTabClosing(String) Method

Sets the name of the JavaScript function or the entire code that will handle the Web Report Designer‘s ReportTabClosing client-side event.

Namespace: DevExpress.AspNetCore.Reporting.ReportDesigner

Assembly: DevExpress.AspNetCore.Reporting.v24.2.dll

NuGet Package: DevExpress.AspNetCore.Reporting

#Declaration

public ReportDesignerClientSideEventsBuilder ReportTabClosing(
    string callback
)

#Parameters

Name Type Description
callback String

The name of a JavaScript function or the entire JavaScript function code used to handle the ReportTabClosing event.

#Returns

Type Description
ReportDesignerClientSideEventsBuilder

A ReportDesignerClientSideEventsBuilder that can be used to further configure the Report Designer Client Side Events.

#Remarks

The ReportTabClosing event enables you to respond to closing a report tab in the Web Report Designer. When implementing a handling function, use the objects passed as parameters. The first parameter passes the event sender that is the ClientReportDesigner object. The second one is an object with the following structure.

  • ReadyToClose
    Specifies the JQueryDeferred object that when resolved, forces the report tab to be closed.

  • Handled
    Specifies whether or not the event was handled.

  • Tab
    Specifies the report tab currently being processed.

The code sample below demonstrates how to use this event to prevent closing a specific report tab.

@{
    var designer = Html.DevExpress().ReportDesigner("reportDesigner1").Height("1000px")
        .Bind(Model.Report)
        .DataSources(configureDS => { foreach (var ds in Model.DataSources) { configureDS.Add(ds.Key, ds.Value); } })
        .ClientSideEvents(configure => { configure.ReportTabClosing("reportTabClosing"); });
}
@designer
See Also