Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class VerticalPageBreak

Represents a vertical page break in a [[Worksheet]].

See

[[PrintOptions.verticalPageBreaks]]

Hierarchy

Hierarchy (view full)

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new VerticalPageBreak(firstColumOnPage): VerticalPageBreak

  • Parameters

    • firstColumOnPage: number

    Returns VerticalPageBreak

  • new VerticalPageBreak(firstColumOnPage, printArea): VerticalPageBreak

  • Parameters

    • firstColumOnPage: number
    • printArea: WorksheetRegion

      Gets the print area in which the page break occurs. A instance that is the print area where the page break occurs or null if the page break occurs across the entire sheet.

      See

      • [[WorksheetRegion]]
      • [[PrintOptions.printAreas]]

    Returns VerticalPageBreak

  • new VerticalPageBreak(firstColumOnPage, min, max): VerticalPageBreak

  • Parameters

    • firstColumOnPage: number
    • min: number
    • max: number

    Returns VerticalPageBreak

  • new VerticalPageBreak(..._rest): VerticalPageBreak

  • Parameters

    • ..._rest: any[]

    Returns VerticalPageBreak

Properties

$type

$type: Type

Static$t

$t: Type

StaticnextHashCode

nextHashCode: number

Accessors

firstColumnOnPage

  • get firstColumnOnPage(): number

  • Gets the 0-based index of the first column on the page after this break.

    Returns number

printArea

  • get printArea(): WorksheetRegion

  • Gets the print area in which the page break occurs. A instance that is the print area where the page break occurs or null if the page break occurs across the entire sheet.

    See

    • [[WorksheetRegion]]
    • [[PrintOptions.printAreas]]

    Returns WorksheetRegion

  • set printArea(a): void

  • Parameters

    Returns void

Methods

equals

  • equals(obj): boolean

  • Determines whether this [[PageBreak]] is equal to the specified object.

    Parameters

    • obj: any

      The object to test.

    Returns boolean

getHashCode

  • getHashCode(): number

  • Gets the hash code for the [[PageBreak]].

    Returns number

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

Staticcompare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

StaticcompareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

StaticequalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

StaticequalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

StaticgetArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

StaticgetArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

StaticgetHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

StaticreferenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean