IWizardPageMetadata<T> Interface

Stores metadata for a wizard page.

Declaration

interface IWizardPageMetadata<T extends IWizardPage>

Type Parameters

Name Type Description
T IWizardPage

The wizard page.

Remarks

A metadata object provides the functionality to:

  • create a page;
  • work with the page's local state;
  • specify the page's HTML template;
  • specify the page's description.

The PageFactory stores metadata objects for all wizard pages by their IDs. Use the page factory's unregisterMetadata method to remove an existing page from the wizard. Use the registerMetadata method to add a new page to the wizard.

See the following topics for more information:

Inheritance

IWizardPageMetadata<T>

Properties

canFinish Property

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

Declaration

canFinish?: (page: T) => boolean

Property Value

Type Description
(page: T) => boolean

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

Remarks

If this property value is not specified, the wizard uses the page's canFinish property value.

canNext Property

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

Declaration

canNext?: (page: T) => boolean

Property Value

Type Description
(page: T) => boolean

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

Remarks

If this property value is not specified, the wizard uses the page's canNext property value.

create Property

Specifies a function that creates a wizard page.

Declaration

create: () => T

Property Value

Type Description
() => T

A function that creates the wizard page.

description Property

Specifies the page's description.

Declaration

description?: string

Property Value

Type Description
string

The page description.

getState Property

Specifies a function that gets the page's state.

Declaration

getState: (state: any) => any

Property Value

Type Description
(state: any) => any

A function that gets the page's state.

resetState Property

Specifies a function that resets the page's state.

Declaration

resetState: (state: any, defaultState?: any) => void

Property Value

Type Description
(state: any, defaultState?: any) => void

A function that resets the page's state.

setState Property

Specifies a function that sets the page's state.

Declaration

setState: (data: any, state: any) => void

Property Value

Type Description
(data: any, state: any) => void

A function that sets the page's state.

template Property

Specifies the page's HTML template.

Declaration

template: string

Property Value

Type Description
string

The page's HTML template.