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

PageFactory Class

Stores metadata for all wizard pages.

#Declaration

TypeScript
export class PageFactory

#Remarks

The page factory stores metadata for all wizard pages by their IDs. A metadata object implements the IWizardPageMetadata interface. The StateManager uses its getState and setState methods to manipulate with a local page state.

You can use the page factory’s unregisterMetadata method to remove a specific page from the wizard.

#Inheritance

#Properties

#metadata Property

Specifies the collection of metadata objects for wizard pages.

#Declaration

TypeScript
metadata: {
    [key: string]: DevExpress.Analytics.Wizard.IWizardPageMetadata<IWizardPage>;
}

#Property Value

Type Description
[key: string]: IWizardPageMetadata<IWizardPage>

The collection of metadata objects.

#Methods

#getMetadata(pageId) Method

Returns the specified page’s metadata.

#Declaration

TypeScript
getMetadata(
    pageId: string
): DevExpress.Analytics.Wizard.IWizardPageMetadata<IWizardPage>

#Parameters

Name Type
pageId string

#Returns

Type Description
IWizardPageMetadata<IWizardPage>

The page metadata.

#registerMetadata<T>(pageId, metadata) Method

Registers the specified page metadata.

#Declaration

TypeScript
registerMetadata<T extends DevExpress.Analytics.Wizard.IWizardPage>(
    pageId: string,
    metadata: DevExpress.Analytics.Wizard.IWizardPageMetadata<T>
): void

#Parameters

Name Type Description
pageId string

The page ID.

metadata IWizardPageMetadata<T>

The page metadata.

#Type Parameters

Name Type Description
T IWizardPage

The page.

#Remarks

Use this method to add a new page to the wizard.

#reset Method

Resets the collection of metadata objects.

#Declaration

TypeScript
reset(): void

#unregisterMetadata(pageId) Method

Removes metadata for the specified page.

#Declaration

TypeScript
unregisterMetadata(
    pageId: string
): void

#Parameters

Name Type Description
pageId string

The page ID.

#Remarks

Use this method to remove a specific page from the wizard.