MultiQueryConfigurePage Class

Implements the Choose Queries section of the Report Wizard's Specify Data Source Settings (Database) page and the Data Source Wizard's Specify Data Source Settings (Database).

Declaration

class MultiQueryConfigurePage extends WizardPageBase<ISqlDataSourceWizardState, ISqlDataSourceWizardState>

Remarks

This page section allows users to select predefined queries or create custom queries.

You can customize this page or remove it from the Specify Data Source Settings (Database) page. To identify this section in code, use the following values:

See the following topics for more information:

Implements

Inherited Members

Inheritance

WizardPageBase<TState, TResult>
MultiQueryConfigurePage

constructor(_options)

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

Declaration

constructor(_options: _MultiQueryDataSourceWizardOptions)

Parameters

Name Type Description
_options _MultiQueryDataSourceWizardOptions

The section's options.

Properties

disableCustomSql Property

Specifies whether the section allows users to write custom SQL queries.

Declaration

disableCustomSql: boolean

Property Value

Type Description
boolean

true, if custom SQL queries are available; otherwise, false.

Methods

canFinish Method

Specifies whether it is possible to finish the wizard.

Declaration

canFinish(): boolean

Returns

Type Description
boolean

true, if it is possible to finish the wizard; otherwise, false.

canNext Method

Specifies whether the next section is available.

Declaration

canNext(): boolean

Returns

Type Description
boolean

true, if the next section is available; otherwise, false.

commit Method

Commits settings to the local page state.

Declaration

commit(): JQuery.Promise<ISqlDataSourceWizardState, any, any>

Returns

Type Description
JQuery.Promise<ISqlDataSourceWizardState,any,any>

A JQuery Promise object that identifies whether the commit succeeded.

initialize(state) Method

Initializes the section with the specified settings.

Declaration

initialize(state: ISqlDataSourceWizardState): JQuery.Promise<Data.Utils.ISqlQueryViewModel, any, any>

Parameters

Name Type Description
state ISqlDataSourceWizardState

The section's state.

Returns

Type Description
JQuery.Promise<ISqlQueryViewModel,any,any>

A JQuery Promise object that identifies whether section initialization succeeded.