ig.excel.PrintAreasCollection

Gets the collection of print areas in a Worksheet or a worksheet's print settings in a CustomView.

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

    .add( printArea:ig.excel.WorksheetRegion );

    Adds a print area to the collection.

    • printArea
    • Type:ig.excel.WorksheetRegion
    • The print area to add to the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when printArea is null.
    ig.ArgumentException Occurs when printArea overlaps with another print area in the collection.
  • clear

    .clear( );

    Clears all print areas from the collection.

    Remarks

    If any page breaks are contained in a print area, they will be removed from their collection.

  • contains

    .contains( printArea:ig.excel.WorksheetRegion );
    Return Type:
    boolean
    Return Type Description:
    True if the print area is in the collection; False otherwise.

    Determines whether the specified print area is in the collection.

    • printArea
    • Type:ig.excel.WorksheetRegion
    • The print area to search for in the collection.
  • count

    .count( );

    Gets the number of print areas in the collection.

  • item

    .item( index:number );
    Return Type:
    ig.excel.WorksheetRegion
    Return Type Description:
    A WorksheetRegion instance representing a print area in the Worksheet.

    Gets the print area at the specified index.

    • index
    • Type:number
    • The index of the print area to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Occurs when index is less than 0 or greater than or equal to the size of the collection.
  • remove

    .remove( printArea:ig.excel.WorksheetRegion );
    Return Type:
    boolean
    Return Type Description:
    True if the print area was found and removed; False otherwise.

    Removes the specified print area from the collection.

    • printArea
    • Type:ig.excel.WorksheetRegion
    • The print area to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentNullException Occurs when printArea is null.

    Remarks

    If any page breaks are contained in the removed print area, they will be removed from their collection.

  • removeAt

    .removeAt( index:number );

    Removes the print area at the specified index from the collection.

    • index
    • Type:number
    • The index of the print area to remove from the collection.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException Occurs when index is less than 0 or greater than or equal to the size of the collection.

    Remarks

    If any page breaks are contained in the removed print area, they will be removed from their collection.

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