Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

IWizardPageMetadata<T> Interface

Stores metadata for a wizard page.

#Declaration

TypeScript
export interface IWizardPageMetadata<T extends DevExpress.Analytics.Wizard.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

#alwaysShowTitle Property

#Declaration

TypeScript
alwaysShowTitle?: boolean

#Property Value

Type
boolean

#canFinish Property

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

#Declaration

TypeScript
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

TypeScript
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

TypeScript
create: () => T

#Property Value

Type Description
() => T

A function that creates the wizard page.

#description Property

Specifies the page’s description.

#Declaration

TypeScript
description?: string

#Property Value

Type Description
string

The page description.

#getState Property

Specifies a function that gets the page’s state.

#Declaration

TypeScript
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

TypeScript
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

TypeScript
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

TypeScript
template: string

#Property Value

Type Description
string

The page’s HTML template.