SelectLabelTypePage<TState, TResult> Class

Implements the Select Label Type section of the Report Wizard’s Specify Page Settings (Label) page.

Declaration

export class SelectLabelTypePage 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 Specify Page Settings page. To identify this section in code, use the FullscreenReportWizardSectionId.SelectLabelTypePage value.

See the following topics for more information:

Implements

Inherited Members

constructor

Creates a new instance of the SelectLabelTypePage<TState, TResult> class with the default settings.

Declaration

constructor()

Methods

canFinish Method

Specifies whether it is possible to finish the wizard.

Declaration

canFinish(): boolean

Returns

Type Description
boolean

true, it is possible to finish the wizard; otherwise, false.

canNext Method

Declaration

canNext(): boolean

Returns

Type
boolean

commit Method

Commits settings to the local page state.

Declaration

commit(): JQuery.Promise<{
    labelDetails: ILabelDetails;
}, any, any>

Returns

Type Description
JQuery.Promise<{labelDetails: ILabelDetails},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: IReportWizardState): JQueryPromise<{
    labelProducts: ILabelProduct[];
    paperKinds: IPaperKind[];
    labelDetails: ILabelDetails[];
}>

Parameters

Name Type Description
state IReportWizardState

The section’s state.

Returns

Type Description
JQueryPromise<{labelDetails: ILabelDetails[], labelProducts: ILabelProduct[], paperKinds: IPaperKind[]}>

A JQuery Promise object that identifies whether section initialization succeeded.