ig.excel.HorizontalPageBreak

Represents a horizontal page break in 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.
  • ig.excel.HorizontalPageBreak
    Constructor

    new $.ig.excel.HorizontalPageBreak( firstRowOnPage:number );

    Creates a new HorizontalPageBreak instance.

    • firstRowOnPage
    • Type:number
    • The 0-based index of the first row on the page after this break.
  • ig.excel.HorizontalPageBreak
    Constructor

    new $.ig.excel.HorizontalPageBreak( firstRowOnPage:number, printArea:ig.excel.WorksheetRegion );

    Creates a new HorizontalPageBreak instance.

    • firstRowOnPage
    • Type:number
    • The 0-based index of the first row on the page after this break.
    • printArea
    • Type:ig.excel.WorksheetRegion
    • The print area in which the page break should occur or null to break in the entire sheet.

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when printArea is not null and the firstRowOnPage is outside the print area or the top row index of the print area.
  • equals
    Inherited

    .equals( obj:object );
    Return Type:
    boolean
    Return Type Description:
    True if the object is the same type as this PageBreak and has the same data; False otherwise.

    Determines whether this PageBreak is equal to the specified object.

    • obj
    • Type:object
    • The object to test.
  • firstRowOnPage

    .firstRowOnPage( );

    Gets the 0-based index of the first row on the page after this break.

  • getHashCode
    Inherited

    .getHashCode( );
    Return Type:
    number
    Return Type Description:
    A hash code for the instance.

    Gets the hash code for the PageBreak.

  • printArea
    Inherited

    .printArea( );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    A instance that is the print area where the page break occurs or null if the page break occurs across the entire sheet.

    Gets the print area in which the page break occurs.

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