SelectReportTypePage Class

Implements the Report Wizard’s Select Report Type page.

Declaration

export class SelectReportTypePage extends AnalyticChooseDataSourceTypePage

Remarks

This wizard page allows users to select a report type to create.

You can hide specific report types or remove this page from the Report Wizard. To identify this page in code, use the FullscreenReportWizardPageId.SelectReportTypePage enumeration value.

See the following topics for more information:

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

Inheritance

SelectReportTypePage

AISelectDataSourceOptionPage

constructor(_options)

Creates a new instance of the SelectReportTypePage class with the specified settings.

Declaration

constructor(
    _options: DevExpress.Reporting.Designer.Wizard.ISelectReportTypePageOptions
)

Parameters

Name	Type	Description
_options	ISelectReportTypePageOptions	The page settings.

Properties

defaultImageID Property

Declaration

static defaultImageID: string

Property Value

Type
string

selectedItem Property

Declaration

selectedItem: ko.Observable<DevExpress.Reporting.Designer.Utils.IReportWizardTypeItem>

Property Value

Type
Observable<IReportWizardTypeItem>

typeItems Property

Declaration

typeItems: DevExpress.Reporting.Designer.Utils.IReportWizardTypeItem[]

Property Value

Type
IReportWizardTypeItem[]

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.

commit Method

Commits the page’s local state to the global state.

Declaration

commit(): JQuery.Promise<Partial<DevExpress.Reporting.Designer.Wizard.IReportWizardState>, any, any>

Returns

Type	Description
Promise<Partial<IReportWizardState>,any,any>	A JQuery Promise object that identifies whether the commit succeeded.

getListOptions Method

Declaration

getListOptions(): object

Returns

Type
object

initialize(state) Method

Initializes the page with the specified settings.

Declaration

initialize(
    state: DevExpress.Reporting.Designer.Wizard.IReportWizardState
): JQuery.Promise<any, any, any>

Parameters

Name	Type	Description
state	IReportWizardState	A page’s local state to initialize.

Returns

Type	Description
Promise<any,any,any>	A JQuery Promise object that identifies whether page initialization succeeded.

Remarks

You can use the wizard’s beforePageInitialize and afterPageInitialize events to customize the page.

See the following topics for more information:

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

itemsFilter(item) Method

Declaration

itemsFilter(
    item: DevExpress.Reporting.Designer.Utils.IReportWizardTypeItem
): boolean

Parameters

Name	Type
item	IReportWizardTypeItem

Returns

Type
boolean