WizardPageBase<TState, TResult> Class
In This Article
A base class for pages of the Report Wizard or Data Source Wizard.
#Declaration
TypeScript
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
IWizardPage
#Inheritance
Show 25 items
WizardPageBase<TState, TResult>
#Properties
#changeAlways Property
#Declaration
TypeScript
changeAlways: boolean
#Property Value
Type |
---|
boolean |
#Methods
#canFinish Method
Specifies whether the Finish button is enabled on a wizard page.
#Declaration
TypeScript
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
TypeScript
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
TypeScript
commit(): JQuery.Promise<TResult, any, any>
#Returns
Type | Description |
---|---|
Promise |
A JQuery Promise object that identifies whether the commit succeeded. |
#dispose Method
Disposes the page.
#Declaration
TypeScript
dispose(): void
#initialize(state) Method
Initializes the page.
#Declaration
TypeScript
initialize(
state: TState,
stateChanged?: boolean
): JQuery.Promise<any, any, any>
#Parameters
Name | Type | Description |
---|---|---|
state | TState | The page’s state. |
state |
boolean |
#Returns
Type | Description |
---|---|
Promise |
A JQuery Promise object that identifies whether page initialization succeeded. |
#onChange(callback) Method
Allows you to handle any changes of page settings.
#Declaration
TypeScript
onChange(
callback: any
): void
#Parameters
Name | Type | Description |
---|---|---|
callback | any | A function that is called on any page changes. |