FsRow (FsSpreadsheet)

FsRow Type

Namespace: FsSpreadsheet
Assembly: FsSpreadsheet.dll
Base Type: FsRangeBase
All Interfaces: IEnumerable<FsCell> , IEnumerable

Creates an FsRow from the given FsRangeAddress, consisting of FsCells within a given FsCellsCollection, and a styleValue.

The FsCellsCollection must only cover 1 row!

Constructors

Constructor Description

Constructor	Description
`FsRow(rangeAddress, cells)` Full Usage: `FsRow(rangeAddress, cells)` Parameters: rangeAddress : `FsRangeAddress` cells : `FsCellsCollection` Returns: `FsRow`	rangeAddress : `FsRangeAddress` cells : `FsCellsCollection` Returns: `FsRow`


                
                  
                    
                      FsRow(rangeAddress, cells)

Full Usage: FsRow(rangeAddress, cells)

Parameters:

rangeAddress : FsRangeAddress

cells : FsCellsCollection

Returns: FsRow

rangeAddress : FsRangeAddress
cells : FsCellsCollection

Returns: FsRow

Instance members

Instance member	Description
`this.Cells` Full Usage: `this.Cells` Returns: `FsCell seq`	The associated FsCells. Returns: `FsCell seq`
`this.Copy` Full Usage: `this.Copy` Returns: `FsRow`	Creates a deep copy of this FsRow. Returns: `FsRow`
`this.HasCellAt` Full Usage: `this.HasCellAt` Parameters: colIndex : `int` - The number of the column where the presence of an FsCell shall be checked. Returns: `bool`	Checks if there is an FsCell at given column index. colIndex : `int` The number of the column where the presence of an FsCell shall be checked. Returns: `bool`
`this.Index` Full Usage: `this.Index`	The index of the FsRow.
`this.InsertValueAt` Full Usage: `this.InsertValueAt` Parameters: colIndex : `int` value : `'a`	Inserts the value at columnIndex as an FsCell. If there is an FsCell at the position, this FsCells and all the ones right to it are shifted to the right. colIndex : `int` value : `'a`
`this[columnIndex]` Full Usage: `this[columnIndex]` Parameters: columnIndex : `int` Returns: `FsCell`	Returns the FsCell at columnIndex if it exists. Else creates an empty FsCell at that position. columnIndex : `int` Returns: `FsCell`
`this.MaxColIndex` Full Usage: `this.MaxColIndex` Returns: `int`	The number of the highest column index of the FsRow where an FsCell exists. Returns: `int`
`this.MinColIndex` Full Usage: `this.MinColIndex` Returns: `int`	The number of the lowest column index of the FsRow where an FsCell exists. Returns: `int`
`this.ToDenseRow` Full Usage: `this.ToDenseRow`	Transforms the FsRow into a dense FsRow. FsRows are sparse by default. This means there are no FsCells present between positions with that are filled with FsCells. In dense FsRows, such "empty positions" are then filled with empty FsCells.
`this.TryItem` Full Usage: `this.TryItem` Parameters: colIndex : `int` - The number of the column where the FsCell shall be retrieved. Returns: `FsCell option`	Returns the FsCell at the given columnIndex if it exists. Else returns None. colIndex : `int` The number of the column where the FsCell shall be retrieved. Returns: `FsCell option`

Static members

Static member	Description
`FsRow.copy row` Full Usage: `FsRow.copy row` Parameters: row : `FsRow` Returns: `FsRow`	Returns a deep copy of a given FsRow. row : `FsRow` Returns: `FsRow`
`FsRow.createAt (index, cells)` Full Usage: `FsRow.createAt (index, cells)` Parameters: index : `int32` cells : `FsCellsCollection` Returns: `FsRow`	Creates an FsRow from a given FsCellsCollection and an rowIndex. The appropriate range of the cells (i.e. minimum colIndex and maximum colIndex) is derived from the FsCells with the matching rowIndex. index : `int32` cells : `FsCellsCollection` Returns: `FsRow`
`FsRow.createDenseRowOf row` Full Usage: `FsRow.createDenseRowOf row` Parameters: row : `FsRow` - The FsRow that whose copy gets transformed into a dense FsRow. Returns: `FsRow`	Takes a given FsRow and returns a new dense FsRow from it. FsRows are sparse by default. This means there are no FsCells present between positions with that are filled with FsCells. In dense FsRows, such "empty positions" are then filled with empty FsCells. row : `FsRow` The FsRow that whose copy gets transformed into a dense FsRow. Returns: `FsRow`
`FsRow.empty ()` Full Usage: `FsRow.empty ()` Returns: `FsRow`	Returns: `FsRow`
`FsRow.getIndex row` Full Usage: `FsRow.getIndex row` Parameters: row : `FsRow` Returns: `int`	Returns the index of the given FsRow. row : `FsRow` Returns: `int`
`FsRow.hasCellAt colIndex row` Full Usage: `FsRow.hasCellAt colIndex row` Parameters: colIndex : `int` - The number of the column where the presence of an FsCell shall be checked. row : `FsRow` - Returns: `bool`	Checks if there is an FsCell at given column index of a given FsRow. colIndex : `int` The number of the column where the presence of an FsCell shall be checked. row : `FsRow` Returns: `bool`
`FsRow.insertValueAt colIndex value row` Full Usage: `FsRow.insertValueAt colIndex value row` Parameters: colIndex : `int` value : `IConvertible` row : `FsRow` Returns: `FsRow`	Adds a value at the given row- and columnIndex to FsRow using. If a cell exists in the given position, shoves it to the right. colIndex : `int` value : `IConvertible` row : `FsRow` Returns: `FsRow`
`FsRow.item colIndex row` Full Usage: `FsRow.item colIndex row` Parameters: colIndex : `int` row : `FsRow` Returns: `FsCell`	Returns the FsCell at the given columnIndex from an FsRow if it exists. Else creates an ampty FsCell at that position. colIndex : `int` row : `FsRow` Returns: `FsCell`
`FsRow.toDenseRow row` Full Usage: `FsRow.toDenseRow row` Parameters: row : `FsRow` - The FsRow that gets transformed into a dense FsRow. Returns: `FsRow`	Transforms the given FsRow into a dense FsRow. FsRows are sparse by default. This means there are no FsCells present between positions with that are filled with FsCells. In dense FsRows, such "empty positions" are then filled with empty FsCells. This is an in-place operation. row : `FsRow` The FsRow that gets transformed into a dense FsRow. Returns: `FsRow`
`FsRow.tryItem colIndex row` Full Usage: `FsRow.tryItem colIndex row` Parameters: colIndex : `int` - The number of the column where the FsCell shall be retrieved. row : `FsRow` - Returns: `FsCell option`	Returns the FsCell at the given columnIndex if it exists in the given FsRow. Else returns None. colIndex : `int` The number of the column where the FsCell shall be retrieved. row : `FsRow` Returns: `FsCell option`