ChooseDataSourceTypePage Class

Implements the Data Source Wizard's Select Data Source Type page.

Declaration

class ChooseDataSourceTypePage extends WizardPageBase<IDataSourceWizardState, IDataSourceWizardState>

Remarks

This wizard page allows users to select a data source type to create.

You can hide specific data source types or remove this page from the Data Source Wizard. To identify this page in code, use the FullscreenDataSourceWizardPageId.ChooseDataSourceTypePage enumeration value.

See the following topics for more information:

Implements

Inherited Members

constructor(_dataSourceTypeOptions)

Declaration

constructor(_dataSourceTypeOptions: _DataSourceWizardOptions)

Parameters

Name Type
_dataSourceTypeOptions _DataSourceWizardOptions

Properties

selectedItem Property

Specifies the selected data source type.

Declaration

selectedItem: ko.Observable<ITypeItem>

Property Value

Type Description
Observable<ITypeItem>

The selected data source type.

typeItems Property

Specifies the collection of available data source types.

Declaration

typeItems: ITypeItem[]

Property Value

Type Description
ITypeItem[]

The collection of available data source types.

Remarks

You can handle the wizard's beforePageInitialize and hide unnecessary data source types.

See the following topics for more information:

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

Returns

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

A page's state.

initialize(state) Method

Initializes the page with the specified settings.

Declaration

initialize(state: IDataSourceWizardState): JQuery.Promise<any, any, any>

Parameters

Name Type Description
state IDataSourceWizardState

A page's local state to initialize.

Returns

Type Description
JQuery.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: