ig.excel.VerticalPageBreakCollection

A collection of horizontal page breaks on a Worksheet.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • add
    Inherited

    .add( pageBreak:ig.excel.VerticalPageBreak );

    Adds a page break to the PageBreakCollection`1.worksheet.

    • pageBreak
    • Type:ig.excel.VerticalPageBreak
    • The page break to add to the Worksheet.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when pageBreak is null.
    ig.ArgumentException Occurs when pageBreak overlaps with another page break already in the collection.
  • clear
    Inherited

    .clear( );

    Clears the collection of page breaks.

  • contains
    Inherited

    .contains( pageBreak:ig.excel.VerticalPageBreak );
    Return Type:
    boolean
    Return Type Description:
    True if the page break is on the Worksheet; False otherwise.

    Determines whether the specified page break exists on the PageBreakCollection`1.worksheet.

    • pageBreak
    • Type:ig.excel.VerticalPageBreak
    • The page break to test.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when pageBreak is null.
  • count
    Inherited

    .count( );

    Gets the number of page breaks in this collection.

  • indexOf
    Inherited

    .indexOf( pageBreak:ig.excel.VerticalPageBreak );
    Return Type:
    number
    Return Type Description:
    The 0-based index of the page break or -1 if the page break is no tin the collection.

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

    • pageBreak
    • Type:ig.excel.VerticalPageBreak
    • The page break for which the index should be obtained.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when pageBreak is null.
  • item
    Inherited

    .item( index:number );
    Return Type:
    ig.excel.VerticalPageBreak
    Return Type Description:
    A PageBreak-derived instance.

    Gets the page break at the specified index.

    • index
    • Type:number
    • The index of the page break to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Occurs when index is less than 0 or greater than of equal to PageBreakCollection`1.count.
  • remove
    Inherited

    .remove( pageBreak:ig.excel.VerticalPageBreak );
    Return Type:
    boolean
    Return Type Description:
    True if the page break was contained on the Worksheet before removal; False otherwise.

    Removes the specified page break from the PageBreakCollection`1.worksheet.

    • pageBreak
    • Type:ig.excel.VerticalPageBreak
    • The page break which should be removed.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when pageBreak is null.
  • removeAt
    Inherited

    .removeAt( index:number );

    Removes the page break at the specified index.

    • index
    • Type:number
    • The 0-based index of the page break to remove.

    Exceptions

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

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.