ReportDesignerClientSideEventsBuilder.ReportTabClosed(String) Method

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

Namespace: DevExpress.AspNetCore.Reporting.ReportDesigner

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

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public ReportDesignerClientSideEventsBuilder ReportTabClosed(
    string callback
)

VB.NET

Public Function ReportTabClosed(
    callback As String
) As ReportDesignerClientSideEventsBuilder

Parameters

Name	Type	Description
callback	String	The name of a JavaScript function or the entire JavaScript function code used to handle the ReportTabClosed event.

Returns

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

Remarks

The ReportTabClosed 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 field exposed.

• Tab
  Specifies the report tab currently being processed.

The code sample below demonstrates how to use this event to show an information message about closing the tab.

CSHTML

@{
    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.ReportTabClosed("reportTabClosed"); });
}
@designer

JavaScript

<script type="text/javascript" id="script"> 
    function reportTabClosed(s, e) {
        alert("The " + e.Tab.displayName() + " tab was closed.");
    }
</script>