ConfigureMasterDetailRelationshipsPage Class
Implements the Configure Master-Detail Relationships 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 ConfigureMasterDetailRelationshipsPage extends WizardPageBase<ISqlDataSourceWizardState, ISqlDataSourceWizardState>
Remarks
This page section allows users to create master-detail relationships between two or more queries.
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.ConfigureMasterDetailRelationshipsPage for the Report Wizard;
- FullscreenDataSourceWizardSectionId.ConfigureMasterDetailRelationshipsPage 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
Inherited Members
Inheritance
constructor(_sqlDataSourceResultSchema)
Creates a new instance of the ConfigureMasterDetailRelationshipsPage
class with the specified settings.
Declaration
constructor(_sqlDataSourceResultSchema: (dataSource: Data.SqlDataSource, queryName?: string, relationsEditing?: boolean) => JQueryPromise<{
resultSchemaJSON: string;
connectionParameters?: string;
}>)
Parameters
Name | Type | Description |
---|---|---|
_sqlDataSourceResultSchema | (dataSource: SqlDataSource, queryName?: string, relationsEditing?: boolean) => JQueryPromise<{connectionParameters: string, resultSchemaJSON: string}> | The section’s options. |
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. |
dispose Method
Disposes the section.
Declaration
dispose(): void
initialize(state) Method
Initializes the section with the specified settings.
Declaration
initialize(
state: ISqlDataSourceWizardState
): JQueryPromise<Data.ResultSet>
Parameters
Name | Type | Description |
---|---|---|
state | ISqlDataSourceWizardState | The section’s state. |
Returns
Type | Description |
---|---|
JQueryPromise<ResultSet> | A JQuery Promise object that identifies whether section initialization succeeded. |