A collection of horizontal page breaks on a Worksheet.

See

Hierarchy

Hierarchy

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get count(): number
  • Gets the number of page breaks in this collection.

    Returns number

Methods

  • Determines whether the specified page break exists on the worksheet.

    Throws

    ArgumentNullException Occurs when 'pageBreak' is null.

    Returns

    True if the page break is on the Worksheet; False otherwise.

    Parameters

    Returns boolean

  • Parameters

    • other: any

    Returns boolean

  • Gets the 0-based index of the specified page break.

    Throws

    ArgumentNullException Occurs when 'pageBreak' is null.

    Returns

    The 0-based index of the page break or -1 if the page break is no tin the collection.

    Parameters

    • pageBreak: VerticalPageBreak

      The page break for which the index should be obtained.

    Returns number

  • Gets the page break at the specified index.

    Throws

    ArgumentOutOfRangeException Occurs when 'index' is less than 0 or greater than of equal to count.

    Returns

    A PageBreak-derived instance.

    Parameters

    • index: number

      The index of the page break to get.

    Returns VerticalPageBreak

  • Removes the specified page break from the worksheet.

    Throws

    ArgumentNullException Occurs when 'pageBreak' is null.

    Returns

    True if the page break was contained on the Worksheet before removal; False otherwise.

    See

    PrintOptions.clearPageBreaks

    Parameters

    Returns boolean

  • Removes the page break at the specified index.

    Throws

    ArgumentOutOfRangeException Occurs when 'index' is less than zero or greater than or equal to the number of page breaks in the collection.

    See

    PrintOptions.clearPageBreaks

    Parameters

    • index: number

      The 0-based index of the page break to remove.

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean