SpecifyPageSettingsPage<TState, TResult> Class

Implements the Report Wizard’s Specify Page Settings page.

Declaration

class SpecifyPageSettingsPage extends Analytics.Wizard.FullscreenWizardPage

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).

Remarks

This wizard page allows users to specify page settings and a report color scheme.

You can customize this page, hide specific sections or remove this page from the Report Wizard. To identify this page in code, use the FullscreenReportWizardPageId.SpecifyPageSettingsPage enumeration value.

See the following topics for more information:

• Customize the Report/Data Source Wizard (ASP.NET WebForms)
• Customize the Report/Data Source Wizard (ASP.NET MVC)
• Customize the Report/Data Source Wizard (ASP.NET Core)

Implements

IWizardPage

Inherited Members

events

commit

dispose

initialize(state)

onChange(callback)

registerSection(sectionId, metadata)

setSectionPosition(sectionId)

unregisterSection(sectionId)

Inheritance

WizardPageBase<TState, TResult>

FullscreenWizardPage<TState, TResult>

SpecifyPageSettingsPage<TState, TResult>

constructor(_reportWizardOptions)

Declaration

constructor(
    _reportWizardOptions: _ReportWizardOptions
)

Parameters

Name	Type
_reportWizardOptions	_ReportWizardOptions

Methods

canFinish Method

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

Declaration

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

canNext(): boolean

Returns

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

getNextSectionId(sectionId) Method

Returns the next section’s ID.

Declaration

getNextSectionId(
    sectionId: any
): string

Parameters

Name	Type	Description
sectionId	any	The current section’s ID.

Returns

Type	Description
string	The next section’s ID.

Remarks

You should override this method when you remove a specific section from the page and want to skip this section in the navigation logic.

See the following topics for more information:

• Customize the Report/Data Source Wizard (ASP.NET WebForms)
• Customize the Report/Data Source Wizard (ASP.NET MVC)
• Customize the Report/Data Source Wizard (ASP.NET Core)

registerSections Method

Registers the page’s sections.

Declaration

registerSections(): void

Remarks

This method registers the following sections in the Specify Page Settings page:

• ConfigurePageSettingsPage - allows users to specify page settings and a report color scheme;
• SpecifyReportTitlePage - allows users to specify the report title.