Back to Devexpress

ASPxClientReportDesignerTabClosingEventArgs Class

xtrareports-js-aspxclientreportdesignertabclosingeventargs.md

latest2.7 KB
Original Source

ASPxClientReportDesignerTabClosingEventArgs Class

Provides data for the ASPxClientReportDesigner.ReportTabClosing event.

Declaration

ts
declare class ASPxClientReportDesignerTabClosingEventArgs extends ASPxClientReportDesignerTabEventArgs

Remarks

ASPxClientReportDesignerTabClosingEventArgs objects are automatically created, initialized and passed to corresponding event handlers.

Inherited Members

Tab

Inheritance

ASPxClientEventArgs ASPxClientReportDesignerTabEventArgs ASPxClientReportDesignerTabClosingEventArgs

See Also

ReportTabClosing

constructor(tab, readyToClose)

Initializes a new instance of the ASPxClientReportDesignerTabClosingEventArgs class with the specified settings.

Declaration

ts
constructor(
    tab: DevExpress.Reporting.Designer.Tools.NavigateTab,
    readyToClose: JQueryDeferred<any>
)

Parameters

NameTypeDescription
tabNavigateTab

An object that specifies the report tab. This value is assigned to the ASPxClientReportDesignerTabEventArgs.Tab property.

| | readyToClose | JQueryDeferred<any> |

A JQuery Deferred object, which when resolved, forces the report tab to be closed. This value is assigned to the ASPxClientReportDesignerTabClosingEventArgs.ReadyToClose property.

|

Properties

Handled Property

Specifies whether or not the event was handled.

Declaration

ts
Handled: boolean

Property Value

TypeDescription
boolean

true , if the event was handled and no other processing should occur; otherwise, false.

|

ReadyToClose Property

Specifies the JQuery Deferred object, which when resolved, forces the report tab to be closed.

Declaration

ts
ReadyToClose: JQueryDeferred<any>

Property Value

TypeDescription
JQueryDeferred<any>

A JQuery Deferred object.

|

Remarks

The report tab is closed when the ReadyToClose deferred object is resolved. Closing the report tab is cancelled when the ReadyToClose object is rejected.