CustomizeLabelPage<TState, TResult> Class

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

Declaration

export class CustomizeLabelPage 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.CustomizeLabelPage value.

See the following topics for more information:

Implements

Inherited Members

constructor

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

Declaration

constructor()

Properties

bottomMargin Property

Specifies the ‘Bottom Margin’ value.

Declaration

bottomMargin: ko.Computed<number>

Property Value

Type Description
Computed<number>

The ‘Bottom Margin’ value.

horizontalPitch Property

Specifies the ‘Horizontal Pitch’ value.

Declaration

horizontalPitch: ko.Computed<number>

Property Value

Type Description
Computed<number>

The ‘Horizontal Pitch’ value.

labelHeight Property

Specifies the ‘Label Height’ value.

Declaration

labelHeight: ko.Computed<number>

Property Value

Type Description
Computed<number>

The ‘Label Height’ value.

labelWidth Property

Specifies the ‘Label Width’ value.

Declaration

labelWidth: ko.Computed<number>

Property Value

Type Description
Computed<number>

The ‘Label Width’ value.

leftMargin Property

Specifies the ‘Left Margin’ value.

Declaration

leftMargin: ko.Computed<number>

Property Value

Type Description
Computed<number>

The ‘Left Margin’ value.

paperKinds Property

Specifies the collection of paper kinds.

Declaration

paperKinds: () => IPaperKind[]

Property Value

Type Description
() => IPaperKind[]

The collection of paper kinds.

rightMargin Property

Specifies the ‘Right Margin’ value.

Declaration

rightMargin: ko.Computed<number>

Property Value

Type Description
Computed<number>

The ‘Right Margin’ value.

topMargin Property

Specifies the ‘Top Margin’ value.

Declaration

topMargin: ko.Computed<number>

Property Value

Type Description
Computed<number>

The ‘Top Margin’ value.

unit Property

Specifies the report units.

Declaration

unit: ko.Observable<GraphicsUnit>

Property Value

Type
Observable<GraphicsUnit>

verticalPitch Property

Specifies the ‘Vertical Pitch’ value.

Declaration

verticalPitch: ko.Computed<number>

Property Value

Type Description
Computed<number>

The ‘Vertical Pitch’ value.

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

Returns

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

A JQuery Promise object that identifies whether the commit succeeded.

initialize(labelDetails) Method

Initializes the section with the specified settings.

Declaration

initialize(labelDetails: ILabelDetails): JQueryPromise<{
    labelProducts: ILabelProduct[];
    paperKinds: IPaperKind[];
    labelDetails: ILabelDetails[];
}>

Parameters

Name Type Description
labelDetails ILabelDetails

The section’s state.

Returns

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

A JQuery Promise object that identifies whether section initialization succeeded.