Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

CustomizeLabelPage Class

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

#Declaration

TypeScript
export class CustomizeLabelPage extends WizardPageBase

#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:

#Inheritance

#constructor

Initializes a new instance of the CustomizeLabelPage class.

#Declaration

TypeScript
constructor()

#Properties

#bottomMargin Property

Specifies the ‘Bottom Margin’ value.

#Declaration

TypeScript
bottomMargin: ko.Computed<number>

#Property Value

Type Description
Computed<number>

The ‘Bottom Margin’ value.

#horizontalPitch Property

Specifies the ‘Horizontal Pitch’ value.

#Declaration

TypeScript
horizontalPitch: ko.Computed<number>

#Property Value

Type Description
Computed<number>

The ‘Horizontal Pitch’ value.

#labelHeight Property

Specifies the ‘Label Height’ value.

#Declaration

TypeScript
labelHeight: ko.Computed<number>

#Property Value

Type Description
Computed<number>

The ‘Label Height’ value.

#labelWidth Property

Specifies the ‘Label Width’ value.

#Declaration

TypeScript
labelWidth: ko.Computed<number>

#Property Value

Type Description
Computed<number>

The ‘Label Width’ value.

#leftMargin Property

Specifies the ‘Left Margin’ value.

#Declaration

TypeScript
leftMargin: ko.Computed<number>

#Property Value

Type Description
Computed<number>

The ‘Left Margin’ value.

#paperKinds Property

Specifies the collection of paper kinds.

#Declaration

TypeScript
paperKinds: () => DevExpress.Reporting.Designer.Wizard.IPaperKind[]

#Property Value

Type Description
() => IPaperKind[]

The collection of paper kinds.

#rightMargin Property

Specifies the ‘Right Margin’ value.

#Declaration

TypeScript
rightMargin: ko.Computed<number>

#Property Value

Type Description
Computed<number>

The ‘Right Margin’ value.

#topMargin Property

Specifies the ‘Top Margin’ value.

#Declaration

TypeScript
topMargin: ko.Computed<number>

#Property Value

Type Description
Computed<number>

The ‘Top Margin’ value.

#unit Property

Specifies the report units.

#Declaration

TypeScript
unit: ko.Observable<DevExpress.Reporting.Designer.Wizard.GraphicsUnit>

#Property Value

Type
Observable<GraphicsUnit>

#verticalPitch Property

Specifies the ‘Vertical Pitch’ value.

#Declaration

TypeScript
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

TypeScript
canFinish(): boolean

#Returns

Type Description
boolean

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

#canNext Method

#Declaration

TypeScript
canNext(): boolean

#Returns

Type
boolean

#commit Method

Commits settings to the local page state.

#Declaration

TypeScript
commit(): JQuery.Promise<DevExpress.Reporting.Designer.Wizard.ILabelDetails, any, any>

#Returns

Type Description
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

TypeScript
initialize(labelDetails: DevExpress.Reporting.Designer.Wizard.ILabelDetails): JQueryPromise<{
    labelProducts: DevExpress.Reporting.Designer.Wizard.ILabelProduct[];
    paperKinds: DevExpress.Reporting.Designer.Wizard.IPaperKind[];
    labelDetails: DevExpress.Reporting.Designer.Wizard.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.