Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class PageBreak

Base class for horizontal and vertical page breaks in a [[Worksheet]].

See

  • [[PrintOptions.clearPageBreaks]]
  • [[PrintOptions.insertPageBreak]]
  • [[PrintOptions.insertPageBreak]]
  • [[PrintOptions.insertPageBreak]]
  • [[PrintOptions.horizontalPageBreaks]]
  • [[PrintOptions.verticalPageBreaks]]
  • [[HorizontalPageBreak]]
  • [[VerticalPageBreak]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new PageBreak(a, b, c): PageBreak

  • Parameters

    • a: number
    • b: Nullable$1<number>
    • c: Nullable$1<number>

    Returns PageBreak

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

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

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean