WizardPageBase<TState, TResult> Class

A base class for pages of the Report Wizard or Data Source Wizard.

Declaration

export class WizardPageBase<TState = any, TResult = any> extends Disposable implements IWizardPage

Type Parameters

Name Description
TState

A type of the state to initialize the page (optional).

TResult

A type of the page’s commit result (optional).

Implements

Methods

canFinish Method

Specifies whether the Finish button is enabled on a wizard page.

Declaration

canFinish(): boolean

Returns

Type Description
boolean

true, if the Finish button is enabled; otherwise, false.

canNext Method

Specifies whether the Next button is enabled on a wizard page.

Declaration

canNext(): boolean

Returns

Type Description
boolean

true, if the Next button is enabled; otherwise, false.

commit Method

Commits the page settings to the state.

Declaration

commit(): JQueryPromise<any>

Returns

Type Description
JQueryPromise<any>

A JQuery Promise object that identifies whether the commit succeeded.

dispose Method

Disposes the page.

Declaration

dispose(): void

initialize(state) Method

Initializes the page.

Declaration

initialize(
    state: TState
): JQueryPromise<any>

Parameters

Name Type Description
state TState

The page’s state.

Returns

Type Description
JQueryPromise<any>

A JQuery Promise object that identifies whether page initialization succeeded.

onChange(callback) Method

Allows you to handle any changes of page settings.

Declaration

onChange(
    callback: any
): void

Parameters

Name Type Description
callback any

A function that is called on any page changes.