SpecifyJsonDataSourceSettingsPage Class

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

Declaration

export class SpecifyJsonDataSourceSettingsPage extends FullscreenWizardPage

Remarks

This wizard page allows users to specify settings of a new JSON 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.SpecifyJsonDataSourceSettingsPage enumeration value.

See the following topics for more information:

• Customize the Report/Data Source Wizard (ASP.NET Web Forms)
• Customize the Report/Data Source Wizard (ASP.NET MVC)
• Customize the Report/Data Source Wizard (ASP.NET Core)

Inherited Members

changeAlways

events

canFinish

commit

dispose

initialize(state)

onChange(callback)

registerSection(sectionId, metadata)

setSectionPosition(sectionId)

unregisterSection(sectionId)

Inheritance

WizardPageBase<TState, TResult>

FullscreenWizardPage

SpecifyJsonDataSourceSettingsPage

constructor(_dataSourceWizardOptions)

Creates a new class instance with the specified settings.

Declaration

constructor(
    _dataSourceWizardOptions: DevExpress.Analytics.Wizard._DataSourceWizardOptions
)

Parameters

Name	Type
_dataSourceWizardOptions	_DataSourceWizardOptions

Methods

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.

getNextSectionId(sectionId) Method

Returns the next section’s ID.

Declaration

getNextSectionId(
    sectionId: string
): string

Parameters

Name	Type	Description
sectionId	string	The current section’s ID.

Returns

Type	Description
string	The next section’s ID.

Remarks

You should override this method when you remove a specific section from the page and want to skip this section in the navigation logic.

See the following topics for more information:

• Customize the Report/Data Source Wizard (ASP.NET Web Forms)
• Customize the Report/Data Source Wizard (ASP.NET MVC)
• Customize the Report/Data Source Wizard (ASP.NET Core)

registerSections Method

Registers the page’s sections.

Declaration

registerSections(): void

Remarks

This method registers the following sections in the Specify Data Source Settings (JSON) page:

• SpecifyJsonConnectionPage (if there are predefined connection strings) - allows users to select a connection string or create a new connection string;
• ChooseJsonSourcePage (if there are no predefined connection strings) - allows users to specify settings for a new connection string;
• ChooseJsonSchemaPage - allows users to select data fields.