Skip to main content
All docs
V25.1
  • CustomizeLabelPage Class

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

    Declaration

    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

    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: () => DevExpress.Reporting.Designer.Wizard.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<DevExpress.Reporting.Designer.Wizard.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

    Declaration

    canNext(): boolean

    Returns

    Type
    boolean

    commit Method

    Commits settings to the local page state.

    Declaration

    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

    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.