ChooseSqlConnectionPage Class

Implements the Choose Data Connection 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 ChooseSqlConnectionPage extends WizardPageBase<ISqlDataSourceWizardState, ISqlDataSourceWizardState>

Remarks

This page section allows users to select a data connection for a new data source.

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:

• FullscreenReportWizardSectionId.ChooseSqlConnectionPage for the Report Wizard;
• FullscreenDataSourceWizardSectionId.ChooseSqlConnectionPage for the Data Source Wizard.

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

canFinish

dispose

onChange(callback)

Inheritance

WizardPageBase<TState, TResult>

ChooseSqlConnectionPage

constructor(connectionStrings)

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

Declaration

constructor(
    connectionStrings: ko.ObservableArray<IConnectionStringDefinition>
)

Parameters

Name	Type	Description
connectionStrings	ObservableArray<IConnectionStringDefinition>	The connection string collection.

Methods

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(): JQueryPromise<ISqlDataSourceWizardState>

Returns

Type	Description
JQueryPromise<ISqlDataSourceWizardState>	A JQuery Promise object that identifies whether the commit succeeded.

initialize(state) Method

Initializes the section with the specified settings.

Declaration

initialize(state: ISqlDataSourceWizardState): JQueryPromise<{}>

Parameters

Name	Type	Description
state	ISqlDataSourceWizardState	The section’s state.

Returns

Type	Description
JQueryPromise<>	A JQuery Promise object that identifies whether section initialization succeeded.