ig.excel.WorksheetMergedCellsRegionCollection

A collection of WorksheetMergedCellsRegion instances in a Worksheet.

Dependencies

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

  • add

    .add( firstRow:number, firstColumn:number, lastRow:number, lastColumn:number );
    Return Type:
    ig.excel.WorksheetMergedCellsRegion
    Return Type Description:
    The newly created WorksheetMergedCellsRegion.

    Creates new merged cell region and adds it to the collection.

    • firstRow
    • Type:number
    • The index of the first row of the merged cell region.
    • firstColumn
    • Type:number
    • The index of the first column of the merged cell region.
    • lastRow
    • Type:number
    • The index of the last row of the merged cell region.
    • lastColumn
    • Type:number
    • The index of the last row column of the merged cell region.

    Exceptions

    Exception Description
    ig.InvalidOperationException firstRow is greater than lastRow or firstColumn is greater than lastColumn.
    ig.InvalidOperationException The new merged cell region overlaps with an existing merged cell region.
    ig.ArgumentOutOfRangeException Any row or column indices specified are outside the valid row or column ranges.

    Remarks

    The new merged cell region will take its value from the first cell containing a value, starting at the top-left and going across then down in the region. The value of all other cells will be lost. Similarly, the new region will initialize its cell format from the first cell containing a non-default cell format.

  • clear

    .clear( );

    Clears all merged cell regions from the collection.

    Remarks

    When a merged cell region is removed, the top-left cell in the region will retain the region's value. All other cells in the region will have a null value. In addition, all cells in the merged region will have the region's cell format when it is removed.

  • count

    .count( );
    Return Type:
    number
    Return Type Description:
    The number of merged cell regions in the collection.

    Gets the number of merged cell regions in the collection.

  • isOverlappingWithMergedRegion

    .isOverlappingWithMergedRegion( firstRow:number, firstColumn:number, lastRow:number, lastColumn:number );
    Return Type:
    boolean
    Return Type Description:
    True if any part of specified region is a part of merged cell region; False otherwise.

    Checks if any part of specified region is already a part of a merged cell region.

    • firstRow
    • Type:number
    • The index of the first row of the merged cell region.
    • firstColumn
    • Type:number
    • The index of the first column of the merged cell region.
    • lastRow
    • Type:number
    • The index of the last row of the merged cell region.
    • lastColumn
    • Type:number
    • The index of the last row column of the merged cell region.

  • item

    .item( index:number );
    Return Type:
    ig.excel.WorksheetMergedCellsRegion
    Return Type Description:
    The merged cell region at the specified index.

    Gets the merged cell region at the specified index.

    • index
    • Type:number
    • The zero-based index of the merged cell region to get.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetMergedCellsRegionCollection.count.

  • remove

    .remove( region:ig.excel.WorksheetMergedCellsRegion );
    Return Type:
    boolean
    Return Type Description:
    True if the merged cell region was successfully removed; False if the merged cell region was not in the collection.

    Removes the specified merged cell region from the collection.

    • region
    • Type:ig.excel.WorksheetMergedCellsRegion
    • The merged cell region to remove from the collection.

    Remarks

    When a merged cell region is removed, the top-left cell in the region will retain the region's value. All other cells in the region will have a null value. In addition, all cells in the merged region will have the region's cell format when it is removed.

  • removeAt

    .removeAt( index:number );

    Removes the merged cell region at the specified index from the collection.

    • index
    • Type:number
    • The zero-based index of the merged cell region in the collection.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException index is less than zero or index is greater than or equal to WorksheetMergedCellsRegionCollection.count.

    Remarks

    When a merged cell region is removed, the top-left cell in the region will retain the region's value. All other cells in the region will have a null value. In addition, all cells in the merged region will have the region's cell format when it is removed.

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