Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class HorizontalPageBreakCollection

A collection of horizontal page breaks on a [[Worksheet]].

See

  • [[PrintOptions.horizontalPageBreaks]]
  • [[HorizontalPageBreak]]

Hierarchy

Hierarchy (view full)

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

  • add(pageBreak): void

  • 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

    • [[PrintOptions.insertPageBreak]]
    • [[PrintOptions.insertPageBreak]]
    • [[PrintOptions.insertPageBreak]]

    Parameters

    Returns void

clear

  • clear(): void

  • Clears the collection of page breaks.

    See

    [[PrintOptions.clearPageBreaks]]

    Returns void

contains

  • contains(pageBreak): boolean

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

    Throws

    [[ArgumentNullException]] Occurs when 'pageBreak' is null.

    Parameters

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getHashCode

indexOf

  • indexOf(pageBreak): number

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

    Throws

    [[ArgumentNullException]] Occurs when 'pageBreak' is null.

    Parameters

    Returns number

item

  • item(index): HorizontalPageBreak

  • Gets the page break at the specified index.

    Throws

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

    Parameters

    • index: number

      The index of the page break to get.

    Returns HorizontalPageBreak

memberwiseClone

remove

  • remove(pageBreak): boolean

  • Removes the specified page break from the [[worksheet]].

    Throws

    [[ArgumentNullException]] Occurs when 'pageBreak' is null.

    See

    [[PrintOptions.clearPageBreaks]]

    Parameters

    Returns boolean

removeAt

  • removeAt(index): void

  • 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

  • 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

Static getArrayOfValues

Static getHashCodeStatic

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean