Represents a row in a Microsoft Excel worksheet.

Hierarchy

Hierarchy

Implements

  • IChangeInfoContext
  • IWorksheetRegionAddressContext

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get cellFormat(): IWorksheetCellFormat
  • Gets the default cell format for cells in this row or column.

    Any default properties of the cell's format will take their value from this format when getting a resolved format.

    The default cell format for cells in this row or column.

    Returns IWorksheetCellFormat

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

    If the height of the row is less than zero, the Worksheet.defaultRowHeight of the owning worksheet will be used as the row's height.

    The value assigned must be between -1 and 8192. Invalid values will be automatically adjusted to valid values.

    The height of the row in twips (1/20th of a point).

    Throws

    InvalidOperationException From the setter if the row was removed from the worksheet.

    Returns number

  • set height(a: number): void
  • Parameters

    • a: number

    Returns void

  • get hidden(): boolean
  • 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.

    Throws

    InvalidOperationException From the stter if the object was removed from the worksheet.

    See

    Returns boolean

  • set hidden(a: boolean): void
  • Parameters

    • a: boolean

    Returns void

  • get index(): number
  • Gets the 0-based index of the row in the worksheet. The 0-based index of the row in the worksheet.

    Returns number

  • get outlineLevel(): number
  • Gets or sets the outline level for the row or column.

    Microsoft Excel supports hierarchical grouping of rows and columns with a maximum of seven levels of hierarchy. To create a group, set adjacent rows or columns to same outline level. When rows or columns are grouped, an outline indicator will provide a visual representation of the outline level. In addition, an outline group has an expansion indicator at one end of the group, which allows the user to easily hide and unhide all rows or column in the group with a single click.

    The outline level for the row or column.

    Throws

    ArgumentOutOfRangeException The value assigned is outside the valid outline level range of 0 and 7.

    Throws

    InvalidOperationException From the stter if the object was removed from the worksheet.

    See

    hidden

    Returns number

  • set outlineLevel(a: number): void
  • Parameters

    • a: number

    Returns void

  • get worksheet(): Worksheet
  • Gets the worksheet to which the row or column belongs. The worksheet to which the row or column belongs.

    Returns Worksheet

Methods

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

  • Parameters

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

    Returns IEnumerable$1<CellDataContext>

  • Parameters

    • a: boolean

    Returns IEnumerable$1<number>

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

    'formula' is parsed based on the CellReferenceMode of the Workbook to which the row belongs. If the row's Worksheet has been removed from its parent collection, the A1 CellReferenceMode will be used to parse the formula.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    ArgumentNullException 'formula' is null or empty.

    Throws

    FormulaParseException 'formula' is not a valid formula.

    Throws

    InvalidOperationException The cell is part of an array formula or data table which is not confined to just the cell.

    Throws

    InvalidEnumArgumentException 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    See

    Parameters

    • columnIndex: number

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

    • formula: string

      The formula to parse and apply to the cell.

    • Optional cellReferenceMode: CellReferenceMode

      The mode used to interpret cell references in the formula.

    Returns void

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

    Note: Iterating the collection will not create all cells. It will only iterate the cells which have already been used. To create and iterate all cells in the worksheet use a For loop, iterating from 0 to one less than the maximum column count, and pass in each index to the collection's indexer.

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

    Throws

    ArgumentOutOfRangeException 'index' is less than zero.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Throws

    InvalidOperationException 'index' is greater than or equal to Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount, depending on the Workbook.currentFormat.

    Parameters

    • index: number

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

    Returns WorksheetCell

  • Gets the collection of cells in the row.

    The collection of cells is a fixed length collection, with the maximum number of cells in the collection being Workbook.maxExcelColumnCount or Workbook.maxExcel2007ColumnCount, depending on the Workbook.CurrentFormat. Internally, the cells are only created and added to the collection when they are requested.

    Note: Iterating the collection will not create all cells. It will only iterate the cells which have already been used. To create and iterate all cells in the worksheet use a For loop, iterating from 0 to one less than MaxExcelColumnCount, and pass in each index to the collection's indexer.

    The collection of cells in the row.

    Returns WorksheetCellCollection

  • Parameters

    • other: any

    Returns boolean

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

    The cells in the left-most column and top-most row of the data table will return null for the associated data table.

    If a data table is associated with the cell, getting the value of the cell with getCellValue will return the calculated value for the cell.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

    The data table to which the cell belongs or null if the cell does not belong to a data table.

    See

    Parameters

    • columnIndex: number

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

    Returns WorksheetDataTable

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

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

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

    See

    WorksheetCell.associatedMergedCellsRegion

    Parameters

    • columnIndex: number

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

    Returns WorksheetMergedCellsRegion

  • Gets the WorksheetTable to which the cell at the specified index belongs.

    A cell belongs to a table if it exists in any area of the table. It can be a header cell, total cell, or a cell in the data area.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    See

    Parameters

    • columnIndex: number

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

    Returns WorksheetTable

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

    The bounds returned by this method are only valid with the current configuration of the worksheet. If any rows or columns before the cell are resized, these bounds will no longer reflect the position of the cell.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

    The bounds of the cell at the specified column index on its worksheet.

    See

    WorksheetCell.getBoundsInTwips

    Parameters

    • columnIndex: number

    Returns IgRect

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

    The bounds returned by this method are only valid with the current configuration of the worksheet. If any rows or columns before the cell are resized, these bounds will no longer reflect the position of the cell.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

    The bounds of the cell at the specified column index on its worksheet.

    See

    WorksheetCell.getBoundsInTwips

    Parameters

    • columnIndex: number

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

    • options: PositioningOptions

      The options to use when getting the bounds of the cell.

    Returns IgRect

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

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

    The comment applied to the cell.

    See

    WorksheetCell.comment

    Parameters

    • columnIndex: number

    Returns WorksheetCellComment

  • 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.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

    The aggregated condition format for the cell at the specified column index or null if the cell is not contained in any conditional format region.

    See

    Parameters

    • columnIndex: number

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

    Returns CellConditionalFormat

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

    Use this method to set cell formatting specific to the cell. If you will be applying the format to numerous cells, see the Workbook.createNewWorksheetCellFormat method for performance considerations.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

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

    See

    Parameters

    • columnIndex: number

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

    Returns IWorksheetCellFormat

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

    If a formula has been applied to the cell, getting the value with the getCellValue method will return the calculated value of the formula.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

    The formula which has been applied to the cell or null if no formula has been applied.

    See

    Parameters

    • columnIndex: number

    Returns Formula

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

    If multiple hyperlinks are applied to the cell, the last one in the Worksheet.hyperlinks collection will be used.

    If the cell has one or more hyperlinks in the Worksheet.hyperlinks collection as well as a formula containing a HYPERLINK function, the last hyperlink from the collection will be used.

    If the cell has a hyperlink due to the HYPERLINK function being used in a formula, the returned value will be sealed.

    See

    Parameters

    • columnIndex: number

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

    Returns WorksheetHyperlink

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

    The display text is based on the value of the cell and the format string applied to the cell.

    See

    Parameters

    • columnIndex: number

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

    Returns string

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

    The text is based on the value of the cell and the format string applied to the cell.

    Throws

    InvalidEnumArgumentException 'textFormatMode' is not defined in the TextFormatMode enumeration.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    See

    Parameters

    • columnIndex: number

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

    • textFormatMode: TextFormatMode

      The format mode to use when getting the cell text.

    Returns string

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

    If this cell belongs to a merged cell region and it is the top-left cell of the region, getting and setting the value will get and set the value of the associated merged cell region. Getting the value of other cells in a merged cell region will always return null. Setting the value of other cells in a merged cell region will have no effect.

    If a formula has been applied to the cell or a data table is associated with the cell, getting the Value will return the calculated value of the cell.

    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

    The value of the cell.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    See

    Parameters

    • columnIndex: number

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

    Returns any

  • Returns number

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

    Returns

    A format object describing the actual formatting that will be used when displayed the row or column in Microsoft Excel.

    Throws

    InvalidOperationException If the object was removed from the worksheet.

    See

    cellFormat

    Returns IWorksheetCellFormat

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

    If any cell format properties are the default values on the cell, 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.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    Returns

    A format object describing the actual formatting that will be used when displayed the cell in Microsoft Excel.

    See

    Parameters

    • columnIndex: number

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

    Returns IWorksheetCellFormat

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

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    InvalidOperationException The value applied only has only one anchor cell set. It should have both or neither anchor cells set.

    Throws

    InvalidOperationException The value has its WorksheetShape.topLeftCornerCell and WorksheetShape.bottomRightCornerCell anchors set but they are from different worksheets.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    See

    WorksheetCell.comment

    Parameters

    Returns void

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

    If this cell belongs to a merged cell region and it is the top-left cell of the region, getting and setting the value will get and set the value of the associated merged cell region. Getting the value of other cells in a merged cell region will always return null. Setting the value of other cells in a merged cell region will have no effect.

    If a formula has been applied to the cell or a data table is associated with the cell, getting the Value will return the calculated value of the cell.

    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

    The value of the cell.

    Throws

    ArgumentOutOfRangeException 'columnIndex' is less than zero or greater than or equal to the number of columns in the worksheet.

    Throws

    NotSupportedException The assigned value's type is not supported and can't be exported to Excel.

    Throws

    InvalidOperationException The value assigned is a Formula. Instead, Formula.applyTo should be called on the Formula, passing in the cell.

    Throws

    InvalidOperationException The value assigned is a WorksheetDataTable. Instead, the WorksheetDataTable.cellsInTable should be set to a region containing the cell.

    Throws

    InvalidOperationException The value assigned is a FormattedString which is the value another cell or merged cell region.

    Throws

    InvalidOperationException The value is assigned and this cell is part of an ArrayFormula or WorksheetDataTable.

    Throws

    InvalidOperationException If the row was removed from the worksheet.

    See

    Parameters

    • columnIndex: number

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

    • value: any

      The value to assign to the cell.

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean