Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class PageBreakCollection$1<T>

Base class for the collections of horizontal and vertical page breaks on a worksheet.

See

Type Parameters

Hierarchy

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Gets the number of page breaks in this collection.

    Returns number

Methods

[iterator]

add

  • Adds a page break to the worksheet.

    Throws

    ArgumentNullException Occurs when 'pageBreak' is null.

    Throws

    ArgumentException Occurs when 'pageBreak' overlaps with another page break already in the collection.

    See

    Parameters

    • pageBreak: T

      The page break to add to the Worksheet.

    Returns void

clear

  • Clears the collection of page breaks.

    See

    PrintOptions.clearPageBreaks

    Returns void

contains

  • 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

    • pageBreak: T

      The page break to test.

    Returns boolean

equals

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • Returns number

indexOf

  • 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: T

      The page break for which the index should be obtained.

    Returns number

item

  • 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 T

memberwiseClone

remove

  • 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

    • pageBreak: T

      The page break which should be removed.

    Returns boolean

removeAt

  • 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

Static compare

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • Parameters

    • a: any
    • b: any

    Returns boolean