FsColumn (FsSpreadsheet)

FsColumn Type

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

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

The FsCellsCollection must only cover 1 column!

Constructors

Constructor Description

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


                
                  
                    
                      FsColumn(rangeAddress, cells)

Full Usage: FsColumn(rangeAddress, cells)

Parameters:

rangeAddress : FsRangeAddress

cells : FsCellsCollection

Returns: FsColumn

rangeAddress : FsRangeAddress
cells : FsCellsCollection

Returns: FsColumn

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: `FsColumn`	Creates a deep copy of this FsColumn. Returns: `FsColumn`
`this.HasCellAt` Full Usage: `this.HasCellAt` Parameters: rowIndex : `int` - The number of the row where the presence of an FsCell shall be checked. Returns: `bool`	Checks if there is an FsCell at given row index. rowIndex : `int` The number of the row where the presence of an FsCell shall be checked. Returns: `bool`
`this.Index` Full Usage: `this.Index`	The index of the FsColumn.
`this[rowIndex]` Full Usage: `this[rowIndex]` Parameters: rowIndex : `int` Returns: `FsCell`	Returns the FsCell at rowIndex. rowIndex : `int` Returns: `FsCell`
`this.MaxRowIndex` Full Usage: `this.MaxRowIndex` Returns: `int`	The number of the highest row index of the FsColumn where an FsCell exists. Returns: `int`
`this.MinRowIndex` Full Usage: `this.MinRowIndex` Returns: `int`	The number of the lowest row index of the FsColumn where an FsCell exists. Returns: `int`
`this.ToDenseColumn` Full Usage: `this.ToDenseColumn`	Transforms the FsColumn into a dense FsColumn. FsColumns are sparse by default. This means there are no FsCells present between positions with that are filled with FsCells. In dense FsColumns, such "empty positions" are then filled with empty FsCells.
`this.TryItem` Full Usage: `this.TryItem` Parameters: rowIndex : `int` - The number of the column where the FsCell shall be retrieved. Returns: `FsCell option`	Returns the FsCell at the given rowIndex if it exists. Else returns None. rowIndex : `int` The number of the column where the FsCell shall be retrieved. Returns: `FsCell option`

Static members

Static member	Description
`FsColumn.copy column` Full Usage: `FsColumn.copy column` Parameters: column : `FsColumn` Returns: `FsColumn`	Returns a deep copy of a given FsColumn. column : `FsColumn` Returns: `FsColumn`
`FsColumn.createAt (index, cells)` Full Usage: `FsColumn.createAt (index, cells)` Parameters: index : `int32` cells : `FsCellsCollection` Returns: `FsColumn`	Create an FsColumn from a given FsCellsCollection and an columnColumn. 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: `FsColumn`
`FsColumn.createDenseColumnOf column` Full Usage: `FsColumn.createDenseColumnOf column` Parameters: column : `FsColumn` - The FsColumn that whose copy gets transformed into a dense FsColumn. Returns: `FsColumn`	Takes a given FsColumn and returns a new dense FsColumn from it. FsColumns are sparse by default. This means there are no FsCells present between positions with that are filled with FsCells. In dense FsColumns, such "empty positions" are then filled with empty FsCells. column : `FsColumn` The FsColumn that whose copy gets transformed into a dense FsColumn. Returns: `FsColumn`
`FsColumn.empty ()` Full Usage: `FsColumn.empty ()` Returns: `FsColumn`	Creates an empty FsColumn, ranging from row 0, column 0 to row 0, column (1-based). Returns: `FsColumn`
`FsColumn.getIndex column` Full Usage: `FsColumn.getIndex column` Parameters: column : `FsColumn` Returns: `int`	Returns the index of the given FsColumn. column : `FsColumn` Returns: `int`
`FsColumn.hasCellAt rowIndex column` Full Usage: `FsColumn.hasCellAt rowIndex column` Parameters: rowIndex : `int` - The number of the row where the presence of an FsCell shall be checked. column : `FsColumn` - Returns: `bool`	Checks if there is an FsCell at given row index of a given FsColumn. rowIndex : `int` The number of the row where the presence of an FsCell shall be checked. column : `FsColumn` Returns: `bool`
`FsColumn.item rowIndex column` Full Usage: `FsColumn.item rowIndex column` Parameters: rowIndex : `int` column : `FsColumn` Returns: `FsCell`	Returns the FsCell at the given rowIndex from an FsColumn. rowIndex : `int` column : `FsColumn` Returns: `FsCell`
`FsColumn.toDenseColumn column` Full Usage: `FsColumn.toDenseColumn column` Parameters: column : `FsColumn` - The FsColumn that gets transformed into a dense FsColumn. Returns: `FsColumn`	Transforms the given FsColumn into a dense FsColumn. FsColumns are sparse by default. This means there are no FsCells present between positions with that are filled with FsCells. In dense FsColumns, such "empty positions" are then filled with empty FsCells. This is an in-place operation. column : `FsColumn` The FsColumn that gets transformed into a dense FsColumn. Returns: `FsColumn`
`FsColumn.tryItem rowIndex column` Full Usage: `FsColumn.tryItem rowIndex column` Parameters: rowIndex : `int` - The number of the column where the FsCell shall be retrieved. column : `FsColumn` - Returns: `FsCell option`	Returns the FsCell at the given rowIndex if it exists in the given FsColumn. Else returns None. rowIndex : `int` The number of the column where the FsCell shall be retrieved. column : `FsColumn` Returns: `FsCell option`