All docs
V21.1
21.1
20.2
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

SpecifyObjectDataSourceSettingsPage Class

Implements the Data Source Wizard’s Specify Data Source Settings (Object) page.

Declaration

export class SpecifyObjectDataSourceSettingsPage extends WizardPageBase<IDataSourceWizardState, IObjectDataSourceWizardState>

Remarks

This wizard page allows users to specify settings of a new object data source.

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

See the following topics for more information:

Implements

Inherited Members

constructor(_dataSourceWizardOptions)

Creates a new SpecifyObjectDataSourceSettingsPage class instance with the specified settings.

Declaration

constructor(
    _dataSourceWizardOptions: _MultiQueryDataSourceWizardOptions
)

Parameters

Name Type
_dataSourceWizardOptions _MultiQueryDataSourceWizardOptions

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 settings to the local page state.

Declaration

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

Returns

Type Description
JQuery.Promise<IObjectDataSourceWizardState,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: IDataSourceWizardState
): JQuery.Promise<any, any, any>

Parameters

Name Type Description
state IDataSourceWizardState

The page initialization settings.

Returns

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

A JQuery Promise object that identifies whether section initialization succeeded.