Represents a row in a Microsoft Excel worksheet.

Constructors

Section titled "Constructors"

WorksheetRow 

new WorksheetRow(a: Worksheet, b: number): WorksheetRow

Returns WorksheetRow

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

cellFormat

Section titled "cellFormat"

Inherited from: RowColumnBase

Gets the default cell format for cells in this row or column.

 
get cellFormat(): IWorksheetCellFormat

Returns IWorksheetCellFormat

height

Section titled "height"

Gets or sets the height of the row in twips (1/20th of a point).

 
get height(): number

Returns number 

set height(a: number): void

Parameters

  • a: number

Returns void

hidden

Section titled "hidden"

Inherited from: RowColumnBase

Gets or sets the value indicating whether the row or column is hidden. The Hidden state also controls the expanded state of rows or columns in outline groups. Basically, an outline group simply provides an easy way to hide and unhide all rows or columns in the group at the same time, via the expansion indicator. The value indicating whether the row or column is hidden.

 
get hidden(): boolean

Returns boolean 

set hidden(a: boolean): void

Parameters

  • a: boolean

Returns void

index

Section titled "index"

Gets the 0-based index of the row in the worksheet. The 0-based index of the row in the worksheet.

 
get index(): number

Returns number

outlineLevel

Section titled "outlineLevel"

Inherited from: RowColumnBase

Gets or sets the outline level for the row or column.

 
get outlineLevel(): number

Returns number 

set outlineLevel(a: number): void

Parameters

  • a: number

Returns void

worksheet

Section titled "worksheet"

Inherited from: RowColumnBase

Gets the worksheet to which the row or column belongs. The worksheet to which the row or column belongs.

 
get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

_cm

Section titled "_cm" 
_cm(): IEnumerable$1<KeyValuePair$2<number, WorksheetCellBlock>>

Returns IEnumerable$1<KeyValuePair$2<number, WorksheetCellBlock>>

_co

Section titled "_co" 
_co(a: number, b: number, c: boolean): IEnumerable$1<CellDataContext>

Parameters

  • a: number
  • b: number
  • c: boolean

Returns IEnumerable$1<CellDataContext>

_cp

Section titled "_cp" 
_cp(a: boolean): IEnumerable$1<number>

Parameters

  • a: boolean

Returns IEnumerable$1<number>

applyCellFormula

Section titled "applyCellFormula"

Applies a formula to the cell at the specified column index.

 
applyCellFormula(columnIndex: number, formula: string, cellReferenceMode: CellReferenceMode): void

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].
  • formula: string

    The formula to parse and apply to the cell.
  • cellReferenceMode: CellReferenceMode

    The mode used to interpret cell references in the formula.

Returns void

cells

Section titled "cells"

Gets the cell at the specified column index in the owning row.

 
cells(index: number): WorksheetCell

Parameters

  • index: number

    The zero-based column index of the cell to get.

Returns WorksheetCell

getCellAssociatedDataTable

Section titled "getCellAssociatedDataTable"

Gets the data table to which the cell at the specified index belongs.

 
getCellAssociatedDataTable(columnIndex: number): WorksheetDataTable

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns WorksheetDataTable

getCellAssociatedMergedCellsRegion

Section titled "getCellAssociatedMergedCellsRegion"

Gets the merged cells region which contains the cell at the specified index, or null if the cell is not merged.

 
getCellAssociatedMergedCellsRegion(columnIndex: number): WorksheetMergedCellsRegion

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns WorksheetMergedCellsRegion

getCellAssociatedTable

Section titled "getCellAssociatedTable"

Gets the [[WorksheetTable]] to which the cell at the specified index belongs.

 
getCellAssociatedTable(columnIndex: number): WorksheetTable

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns WorksheetTable

getCellBoundsInTwips

Section titled "getCellBoundsInTwips"

Gets the bounds of the cell at the specified column index in twips (1/20th of a point).

 
getCellBoundsInTwips(columnIndex: number): IgRect

Parameters

  • columnIndex: number

Returns IgRect

getCellComment

Section titled "getCellComment"

Gets or sets the comment applied to the cell at the specified column index.

 
getCellComment(columnIndex: number): WorksheetCellComment

Parameters

  • columnIndex: number

Returns WorksheetCellComment

getCellConditionalFormat

Section titled "getCellConditionalFormat"

Gets the cell conditional format for the cell at the specified column index. Note: if the cell is contained in one or more conditional format regions but doesn't match any of the criteria an instance of [[CellConditionalFormat]] will still be returned but its [[CellConditionalFormat.hasConditionFormatting]] property will return null. However, if the sell is not contained in any conditional format region then this method will return null.

 
getCellConditionalFormat(columnIndex: number): CellConditionalFormat

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns CellConditionalFormat

getCellFormat

Section titled "getCellFormat"

Gets the cell formatting for the cell at the specified column index.

 
getCellFormat(columnIndex: number): IWorksheetCellFormat

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns IWorksheetCellFormat

getCellFormula

Section titled "getCellFormula"

Gets the formula which has been applied to the cell at the specified column index.

 
getCellFormula(columnIndex: number): Formula

Parameters

  • columnIndex: number

Returns Formula

Section titled "getCellHyperlink"

Gets the effective hyperlink on the cell at the specified index.

 
getCellHyperlink(columnIndex: number): WorksheetHyperlink

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns WorksheetHyperlink

getCellText

Section titled "getCellText"

Gets the display text in the cell at the specified index.

 
getCellText(columnIndex: number): string

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns string

getCellValue

Section titled "getCellValue"

Gets the value of the cell at the specified column index.

 
getCellValue(columnIndex: number): any

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns any

getResolvedCellFormat

Section titled "getResolvedCellFormat"

Gets the resolved cell formatting for the cells in the row or column.

 
getResolvedCellFormat(): IWorksheetCellFormat

Returns IWorksheetCellFormat

setCellComment

Section titled "setCellComment"

Sets the comment applied to the cell at the specified column index.

 
setCellComment(columnIndex: number, comment: WorksheetCellComment): void

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].
  • comment: WorksheetCellComment

    The comment to apply to the cell.

Returns void

setCellValue

Section titled "setCellValue"

Sets the value of a cell at the specified column index.

 
setCellValue(columnIndex: number, value: any): void

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].
  • value: any

    The value to assign to the cell.

Returns void

validateCellValue

Section titled "validateCellValue"

Returns a boolean indicating if the value of the cell is valid considering its associated [[WorksheetCell.dataValidationRule]]

 
validateCellValue(columnIndex: number): boolean

Parameters

  • columnIndex: number

    The 0-based index of the cell within the [[WorksheetRow]].

Returns boolean