ig.excel.WorksheetMergedCellsRegion

Represents a merged region of cells, or cells which share a value and format and appear as one cell when viewed in Microsoft Excel.

Remarks

Merged cell regions cannot overlap (a cell can only belong to one merged cell region). In addition, ArrayFormula and WorksheetDataTable instances cannot be applied to merged cell regions.

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.

  • cellFormat

    .cellFormat( );
    Return Type:
    ig.excel.IWorksheetCellFormat
    Return Type Description:
    The cell formatting for the merged cell region.

    Gets the cell formatting for the merged cell region.

  • comment

    .comment( );
    Return Type:
    ig.excel.WorksheetCellComment
    Return Type Description:
    The comment for the merged cells region.

    Gets the comment for the merged cells region.

    Remarks

    The comment of the merged region can also be accessed from the top-left cell of the merged region of cells.

  • comment

    .comment( value:ig.excel.WorksheetCellComment );
    Return Type:
    ig.excel.WorksheetCellComment
    Return Type Description:
    The comment for the merged cells region.

    Sets the comment for the merged cells region.

    • value
    • Type:ig.excel.WorksheetCellComment

    Remarks

    The comment of the merged region can also be accessed from the top-left cell of the merged region of cells.

  • formula

    .formula( );
    Return Type:
    ig.excel.Formula
    Return Type Description:
    The formula which has been applied to the merged region or null if no formula has been applied.

    Gets the formula which has been applied to the merged region.

  • getResolvedCellFormat

    .getResolvedCellFormat( );
    Return Type:
    ig.excel.IWorksheetCellFormat
    Return Type Description:
    A format object describing the actual formatting that will be used when displayed this cell in Microsoft Excel.

    Gets the resolved cell formatting for this merged cell region.

    Remarks

    If any cell format properties are the default values on the merged cell region, the values from the owning row's cell format will be used. If those are default, then the values from the owning column's cell format will be used. Otherwise, the workbook default values will be used.

    See Also

  • value

    .value( );
    Return Type:
    object
    Return Type Description:
    The value of the merged cell region.

    Gets the value of the merged cell region.

    Exceptions

    Exception Description
    ig.NotSupportedException The assigned value's type is not supported and can't be exported to Excel.
    ig.InvalidOperationException The value assigned is a WorksheetMergedCellsRegion.formula. Instead, Formula.applyTo should be called on the Formula, passing in the cell.
    ig.InvalidOperationException The value assigned is a WorksheetDataTable. Instead, the WorksheetDataTable.cellsInTable should be set to a region containing the cell.
    ig.InvalidOperationException The value assigned is a FormattedString which is the value another cell or merged cell region.
    ig.InvalidOperationException The value is assigned and this cell is part of an ArrayFormula or WorksheetDataTable.

    Remarks

    The types supported for the value are:

    • System.Byte
    • System.SByte
    • System.Int16
    • System.Int64
    • System.UInt16
    • System.UInt64
    • System.UInt32
    • System.Int32
    • System.Single
    • System.Double
    • System.Boolean
    • System.Char
    • System.Enum
    • System.Decimal
    • System.DateTime
    • System.String
    • System.Text.StringBuilder
    • System.DBNull
    • ErrorValue
    • FormattedString

    See Also

  • value

    .value( value:object );
    Return Type:
    object
    Return Type Description:
    The value of the merged cell region.

    Sets the value of the merged cell region.

    • value
    • Type:object

    Exceptions

    Exception Description
    ig.NotSupportedException The assigned value's type is not supported and can't be exported to Excel.
    ig.InvalidOperationException The value assigned is a WorksheetMergedCellsRegion.formula. Instead, Formula.applyTo should be called on the Formula, passing in the cell.
    ig.InvalidOperationException The value assigned is a WorksheetDataTable. Instead, the WorksheetDataTable.cellsInTable should be set to a region containing the cell.
    ig.InvalidOperationException The value assigned is a FormattedString which is the value another cell or merged cell region.
    ig.InvalidOperationException The value is assigned and this cell is part of an ArrayFormula or WorksheetDataTable.

    Remarks

    The types supported for the value are:

    • System.Byte
    • System.SByte
    • System.Int16
    • System.Int64
    • System.UInt16
    • System.UInt64
    • System.UInt32
    • System.Int32
    • System.Single
    • System.Double
    • System.Boolean
    • System.Char
    • System.Enum
    • System.Decimal
    • System.DateTime
    • System.String
    • System.Text.StringBuilder
    • System.DBNull
    • ErrorValue
    • FormattedString

    See Also

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