MultiQueryConfigureParametersPage Class

Implements the Configure Query Parameters 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 MultiQueryConfigureParametersPage extends WizardPageBase<ISqlDataSourceWizardState, ISqlDataSourceWizardState>

Remarks

This page section allows users to create query parameters.

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>
MultiQueryConfigureParametersPage

constructor(parametersConverter, _requestWrapper)

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

Declaration

constructor(parametersConverter: Internal.IParametersViewModelConverter, _requestWrapper: QueryBuilder.Utils.RequestWrapper)

Parameters

Name Type Description
parametersConverter IParametersViewModelConverter

The parameter converter.

_requestWrapper RequestWrapper

The request wrapper.

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<any, any, any>

Parameters

Name Type Description
state ISqlDataSourceWizardState

The section's state.

Returns

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

A JQuery Promise object that identifies whether section initialization succeeded.