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 IWizardPageType 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
IWizardPage
Inheritance
Show 25 items
WizardPageBase<TState, TResult>
Properties
changeAlways Property
Declaration
changeAlways: booleanProperty Value
| Type |
|---|
| boolean |
Methods
canFinish Method
Specifies whether the Finish button is enabled on a wizard page.
Declaration
canFinish(): booleanReturns
| 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(): booleanReturns
| 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(): voidinitialize(state) Method
Initializes the page.
Declaration
initialize(
state: TState,
stateChanged?: boolean
): JQueryPromise<any>Parameters
| Name | Type | Description |
|---|---|---|
| state | TState | The page’s state. |
| stateChanged | boolean |
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
): voidParameters
| Name | Type | Description |
|---|---|---|
| callback | any | A function that is called on any page changes. |