AddSummaryFieldsPage<TState, TResult> Class

Implements the Add Summary Fields section of the Report Wizard’s Define Report Layout page.

Declaration

export class AddSummaryFieldsPage extends WizardPageBase

Type Parameters

Name Description
TState

A type of the state to initialize the page (optional).

TResult

A type of the page’s commit result (optional).

Remarks

You can customize this section or remove it from the Define Report Layout page. To identify this section in code, use the FullscreenReportWizardSectionId.AddSummaryFieldsPage value.

See the following topics for more information:

Implements

Inherited Members

Properties

ignoreNullValues Property

Specifies whether to ignore NULL data field values.

Declaration

ignoreNullValues: ko.Observable<boolean>

Property Value

Type Description
Observable<boolean>

true, to ignore NULL values; otherwise, false.

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.

commit Method

Commits settings to the local page state.

Declaration

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

Returns

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

A JQuery Promise object that identifies whether the commit succeeded.

dispose Method

Disposes the page.

Declaration

dispose(): void

initialize(state) Method

Initializes the section with the specified settings.

Declaration

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

Parameters

Name Type Description
state IReportWizardState

The section’s state.

Returns

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

A JQuery Promise object that identifies whether section initialization succeeded.