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

Constructors

Section titled "Constructors"

WorksheetMergedCellsRegion

new WorksheetMergedCellsRegion(a: Worksheet, b: number, c: number, d: number, e: number): WorksheetMergedCellsRegion

Returns WorksheetMergedCellsRegion

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

comment

Section titled "comment" 
comment: WorksheetCellComment

value

Section titled "value" 
value: any

Accessors

Section titled "Accessors"

cellFormat

Section titled "cellFormat"

Gets the cell formatting for the merged cell region. The cell formatting for the merged cell region.

get cellFormat(): IWorksheetCellFormat

Returns IWorksheetCellFormat

firstColumn

Section titled "firstColumn"

Inherited from: WorksheetRegion

Gets the index of the first column in the region. The index of the first column in the region.

get firstColumn(): number

Returns number

firstRow

Section titled "firstRow"

Inherited from: WorksheetRegion

Gets the index of the first row in the region. The index of the first row in the region.

get firstRow(): number

Returns number

formula

Section titled "formula"

Gets the formula which has been applied to the merged region. The formula which has been applied to the merged region or null if no formula has been applied.

get formula(): Formula

Returns Formula

lastColumn

Section titled "lastColumn"

Inherited from: WorksheetRegion

Gets the index of the last column in the region. The index of the last column in the region.

get lastColumn(): number

Returns number

lastRow

Section titled "lastRow"

Inherited from: WorksheetRegion

Gets the index of the last row in the region. The index of the last row in the region.

get lastRow(): number

Returns number

worksheet

Section titled "worksheet"

Inherited from: WorksheetRegion

Gets the worksheet on which the region resides. The worksheet on which the region resides or null if the region has been shifted off the worksheet.

get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

applyArrayFormula

Section titled "applyArrayFormula"

Inherited from: WorksheetRegion

Applies a array formula to the region of cells.

applyArrayFormula(value: string): void

Parameters

  • value: string

    The array formula to parse and apply to the region.

Returns void

applyFormula

Section titled "applyFormula"

Inherited from: WorksheetRegion

Applies a formula to the region of cells.

applyFormula(value: string): void

Parameters

  • value: string

    The formula to parse and apply to the region.

Returns void

equals

Section titled "equals"

Inherited from: WorksheetRegion

Determines whether the specified value equals this [[WorksheetRegion]].

equals(obj: any): boolean

Parameters

  • obj: any

    The value to test for equality.

Returns boolean

formatAsTable

Section titled "formatAsTable"

Inherited from: WorksheetRegion

Formats the region as a table and adds an associated [[WorksheetTable]] to the [[Worksheet.tables]] collection.

formatAsTable(tableHasHeaders: boolean): WorksheetTable

Parameters

  • tableHasHeaders: boolean

    A value which indicates whether the top row of the region contains the headers for the table.

Returns WorksheetTable

getBoundsInTwips

Section titled "getBoundsInTwips"

Inherited from: WorksheetRegion

Gets the bounds of the region in twips (1/20th of a point).

getBoundsInTwips(): IgRect

Returns IgRect

getEnumerator

Section titled "getEnumerator"

Inherited from: WorksheetRegion 

getEnumerator(): IEnumerator$1<WorksheetCell>

Returns IEnumerator$1<WorksheetCell>

getHashCode

Section titled "getHashCode"

Inherited from: WorksheetRegion

Gtes the hash code for the [[WorksheetRegion]].

getHashCode(): number

Returns number

getResolvedCellFormat

Section titled "getResolvedCellFormat"

Gets the resolved cell formatting for this merged cell region.

getResolvedCellFormat(): IWorksheetCellFormat

Returns IWorksheetCellFormat

toString

Section titled "toString"

Inherited from: WorksheetRegion

Gets the string representation of the range of cells in the region.

toString(): string

Returns string