ReportDialogBase Class
Provides the base functionality for dialogs used to open and save reports in the Web Report Designer.
#Declaration
export class ReportDialogBase extends Disposable
#Inheritance
#Properties
#buttons Property
Provides access to buttons displayed in a dialog.
#Declaration
buttons: any[]
#Property Value
Type | Description |
---|---|
any[] | An array of buttons displayed in the dialog. |
#disabled Property
Specified if a dialog is disabled.
#Declaration
disabled: ko.Observable<boolean>
#Property Value
Type | Description |
---|---|
Observable<boolean> | true, to disable a dialog; otherwise, false. |
#height Property
Specifies a dialog’s height.
#Declaration
height: ko.Observable<any>
#Property Value
Type | Description |
---|---|
Observable<any> | A knockout observable object that specifies a dialog’s height. |
#model Property
Specifies a dialog’s model.
#Declaration
model: ko.Observable<DevExpress.Reporting.Designer.Tools.IDialogModel>
#Property Value
Type | Description |
---|---|
Observable<IDialog |
A knockout observable object of the dialog model. |
#tab Property
Specifies a report tab for which a dialog appears.
#Declaration
tab: ko.Observable<DevExpress.Reporting.Designer.Tools.INavigateTab>
#Property Value
Type | Description |
---|---|
Observable<INavigate |
A knockout observable object of the report tab. |
#template Property
Specifies the name of an HTML template used by a dialog.
#Declaration
template: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | A knockout observable string that specifies the name of the HTML template used by a dialog. |
#visible Property
Specifies a dialog’s visibility state.
#Declaration
visible: ko.Computed<boolean>
#Property Value
Type | Description |
---|---|
Computed<boolean> | true, if the dialog is visible; otherwise, false; |
#width Property
Specifies a dialog’s width.
#Declaration
width: ko.Observable<any>
#Property Value
Type | Description |
---|---|
Observable<any> | A knockout observable object that specifies a dialog’s width. |
#Methods
#cancel Method
Cancels the dialog.
#Declaration
cancel(): void
#customize(template, model) Method
Customizes the dialog based on the specified template and model.
#Declaration
customize(
template: string,
model: DevExpress.Reporting.Designer.Tools.IDialogModel
): void
#Parameters
Name | Type | Description |
---|---|---|
template | string | The name of the dialog’s HTML template. |
model | IDialog |
The dialog model. |
#show(tab) Method
Shows the dialog for the specified report tab.
#Declaration
show(
tab: DevExpress.Reporting.Designer.Tools.INavigateTab
): void
#Parameters
Name | Type | Description |
---|---|---|
tab | INavigate |
A report tab for which the dialog should be shown. |