Header menu logo FsSpreadsheet

FsWorksheet Type

Namespace: FsSpreadsheet
Assembly: FsSpreadsheet.dll
Base Type: obj

Creates an FsWorksheet with the given name, FsRows, FsTables, and FsCellsCollection.

Constructors

Constructor Description

FsWorksheet(name, ?fsRows, ?fsTables, ?fsCellsCollection)

Full Usage: FsWorksheet(name, ?fsRows, ?fsTables, ?fsCellsCollection)

Parameters:
Returns: FsWorksheet
name : string
?fsRows : ResizeArray<FsRow>
?fsTables : ResizeArray<FsTable>
?fsCellsCollection : FsCellsCollection
Returns: FsWorksheet

Instance members

Instance member Description

this.AddCell

Full Usage: this.AddCell

Parameters:
Returns: FsWorksheet

Adds a FsCell to the FsWorksheet. !Exception if cell address already exists!

cell : FsCell
Returns: FsWorksheet

this.AddCells

Full Usage: this.AddCells

Parameters:
Returns: FsWorksheet

Adds a sequence of FsCells to the FsWorksheet. !Exception if cell address already exists!

cells : FsCell seq
Returns: FsWorksheet

this.AddTable

Full Usage: this.AddTable

Parameters:
Returns: FsWorksheet

Adds an FsTable to the FsWorksheet if an FsTable with the same name is not already attached.

table : FsTable
Returns: FsWorksheet

this.AddTables

Full Usage: this.AddTables

Parameters:
    tables : 'a list

Returns: FsWorksheet

Adds a list of FsTables to the FsWorksheet. All FsTables with a name already present in the FsWorksheet are not attached.

tables : 'a list
Returns: FsWorksheet

this.CellCollection

Full Usage: this.CellCollection

Returns: FsCellsCollection

The FsCellCollection of the FsWorksheet.

Returns: FsCellsCollection

this.Column

Full Usage: this.Column

Parameters:
    columnIndex : int32

Returns: FsColumn

Returns the FsColumn at the given index. If it does not exist, it is created and appended first.

columnIndex : int32
Returns: FsColumn

this.ColumnWithRange

Full Usage: this.ColumnWithRange

Parameters:

Returns the FsColumn at the given FsRangeAddress. If it does not exist, it is created and appended first.

rangeAddress : FsRangeAddress

this.Columns

Full Usage: this.Columns

Returns: FsColumn seq

The FsColumns of the FsWorksheet.

Returns: FsColumn seq

this.ContainsRowAt

Full Usage: this.ContainsRowAt

Parameters:
    rowIndex : int

Returns: bool

Returns true if the FsWorksheet contains an FsRow with the given rowIndex.

rowIndex : int
Returns: bool

this.Copy

Full Usage: this.Copy

Returns: FsWorksheet

Returns a copy of the FsWorksheet.

Returns: FsWorksheet

this.GetCellAt

Full Usage: this.GetCellAt

Parameters:
    rowIndex : int32
    colIndex : int32

Returns: FsCell

Returns the FsCell at the given row- and column index. Index is 1 based!

rowIndex : int32
colIndex : int32
Returns: FsCell

this.GetMaxRowIndex

Full Usage: this.GetMaxRowIndex

Returns: FsRow

Returns the highest index of any FsRow.

Returns: FsRow

this.GetRowValuesAt

Full Usage: this.GetRowValuesAt

Parameters:
    rowIndex : int

Returns: obj seq

Gets the string values of the FsRow at the given 1-based rowIndex.

rowIndex : int
Returns: obj seq

this.InsertBefore

Full Usage: this.InsertBefore

Parameters:
Returns: FsWorksheet

Inserts an FsRow into the FsWorksheet before a reference FsRow.

row : FsRow
refRow : FsRow
Returns: FsWorksheet

this.InsertValueAt

Full Usage: this.InsertValueAt

Parameters:
    value : obj
    rowIndex : int
    colIndex : int

Adds a value at the given row- and columnIndex to the FsWorksheet. If a cell exists at the given postion, it is shoved to the right.

value : obj
rowIndex : int
colIndex : int

this.MapRowsInPlace

Full Usage: this.MapRowsInPlace

Parameters:
Returns: FsWorksheet

Applies function f to all FsRows and returns the modified FsWorksheet.

f : FsRow -> FsRow
Returns: FsWorksheet

this.MaxColumnIndex

Full Usage: this.MaxColumnIndex

Returns: int32
Returns: int32

this.MaxRowIndex

Full Usage: this.MaxRowIndex

Returns: int32
Returns: int32

this.Name

Full Usage: this.Name

The name of the FsWorksheet.

this.RemoveCellAt

Full Usage: this.RemoveCellAt

Parameters:
    rowIndex : int
    colIndex : int

Returns: FsWorksheet

Removes the value at the given row- and columnIndex from the FsWorksheet.

rowIndex : int
colIndex : int
Returns: FsWorksheet

this.RemoveRowAt

Full Usage: this.RemoveRowAt

Parameters:
    rowIndex : int

Removes the FsRow at the given rowIndex.

rowIndex : int

this.RemoveValueAt

Full Usage: this.RemoveValueAt

Parameters:
    rowIndex : int
    colIndex : int

Removes the value of an FsCell at given row- and columnIndex from the FsCollection.

rowIndex : int
colIndex : int
ArgumentNullException if rowIndex or columnIndex is null.
KeyNotFoundException if row or column at the given index does not exist.

this.RescanRows

Full Usage: this.RescanRows

Checks the cell collection and recreate the whole set of rows, so that all cells are placed in a row

this.Row

Full Usage: this.Row

Parameters:
    rowIndex : int32
    ?SkipSearch : bool

Returns: FsRow

Returns the FsRow at the given index. If it does not exist, it is created and appended first.

rowIndex : int32
?SkipSearch : bool
Returns: FsRow

this.RowWithRange

Full Usage: this.RowWithRange

Parameters:
    rangeAddress : FsRangeAddress - The range address of the FsRow.
    ?SkipSearch : bool - If true, the FsRow is created and appended without checking if it already exists.

Returns: FsRow

Returns the FsRow at the given FsRangeAddress. If it does not exist, it is created and appended first.

rangeAddress : FsRangeAddress

The range address of the FsRow.

?SkipSearch : bool

If true, the FsRow is created and appended without checking if it already exists.

Returns: FsRow

this.Rows

Full Usage: this.Rows

Returns: ResizeArray<FsRow>

The FsRows of the FsWorksheet.

Returns: ResizeArray<FsRow>

this.SetValueAt

Full Usage: this.SetValueAt

Parameters:
    value : 'a
    rowIndex : int32
    colIndex : int32

Returns: FsWorksheet

Adds a value at the given row- and columnIndex. If an FsCell exists at the given position, overwrites it.

value : 'a
rowIndex : int32
colIndex : int32
Returns: FsWorksheet

this.SortRows

Full Usage: this.SortRows

Sorts the FsRows by their rowIndex.

this.Table

Full Usage: this.Table

Parameters:
    tableName : string
    rangeAddress : FsRangeAddress
    ?showHeaderRow : bool

Returns: FsTable

Returns the FsTable with the given tableName, rangeAddress, and showHeaderRow parameters. If it does not exist yet, it gets created and appended first.

tableName : string
rangeAddress : FsRangeAddress
?showHeaderRow : bool
Returns: FsTable

this.Tables

Full Usage: this.Tables

Returns: ResizeArray<FsTable>

The FsTables of the FsWorksheet.

Returns: ResizeArray<FsTable>

this.TryGetCellAt

Full Usage: this.TryGetCellAt

Parameters:
    rowIndex : int32
    colIndex : int32

Returns: FsCell option

Returns the FsCell at the given row- and columnIndex if the FsCell exists, else returns None.

rowIndex : int32
colIndex : int32
Returns: FsCell option

this.TryGetRowValuesAt

Full Usage: this.TryGetRowValuesAt

Parameters:
    rowIndex : int

Returns: obj seq option

Gets the string values at the given 1-based rowIndex of the FsRow if it exists, else returns None.

rowIndex : int
Returns: obj seq option

this.TryRemoveAt

Full Usage: this.TryRemoveAt

Parameters:
    rowIndex : int

Returns: FsWorksheet

Removes the FsRow at a given rowIndex of the FsWorksheet if the FsRow exists.

rowIndex : int
Returns: FsWorksheet

this.TryRemoveValueAt

Full Usage: this.TryRemoveValueAt

Parameters:
    rowIndex : int
    colIndex : int

Removes the value of an FsCell at given row- and columnIndex if it exists from the FsCollection.

Does nothing if the row or column of given index does not exist.

rowIndex : int
colIndex : int
ArgumentNullException if columnIndex is null.

Static members

Static member Description

FsWorksheet.addCell cell sheet

Full Usage: FsWorksheet.addCell cell sheet

Parameters:
Returns: FsWorksheet

Adds a FsCell to the FsWorksheet. !Exception if cell address already exists!

cell : FsCell
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.addCells cell sheet

Full Usage: FsWorksheet.addCells cell sheet

Parameters:
Returns: FsWorksheet

Adds a sequence of FsCells to the FsWorksheet. !Exception if cell address already exists!

cell : FsCell seq
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.addTable table sheet

Full Usage: FsWorksheet.addTable table sheet

Parameters:
Returns: FsWorksheet

Adds an FsTable to the FsWorksheet if an FsTable with the same name is not already attached.

table : FsTable
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.addTables tables sheet

Full Usage: FsWorksheet.addTables tables sheet

Parameters:
Returns: FsWorksheet

Adds a list of FsTables to an FsWorksheet. All FsTables with a name already present in the FsWorksheet are not attached.

tables : 'a list
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.appendRow row sheet

Full Usage: FsWorksheet.appendRow row sheet

Parameters:
Returns: FsWorksheet

Appends an FsRow to an FsWorksheet if the rowIndex is not already taken.

row : FsRow
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.containsRowAt rowIndex sheet

Full Usage: FsWorksheet.containsRowAt rowIndex sheet

Parameters:
Returns: bool

Returns true if the FsWorksheet contains an FsRow with the given rowIndex.

rowIndex : int
sheet : FsWorksheet
Returns: bool

FsWorksheet.copy sheet

Full Usage: FsWorksheet.copy sheet

Parameters:
Returns: FsWorksheet

Returns a copy of a given FsWorksheet.

sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.countRows sheet

Full Usage: FsWorksheet.countRows sheet

Parameters:
Returns: int

Returns the number of FsRows contained in the FsWorksheet.

sheet : FsWorksheet
Returns: int

FsWorksheet.getCellAt rowIndex colIndex sheet

Full Usage: FsWorksheet.getCellAt rowIndex colIndex sheet

Parameters:
    rowIndex : int32
    colIndex : int32
    sheet : FsWorksheet

Returns: FsCell

Returns the FsCell at the given row- and columnIndex of a given FsWorksheet.

rowIndex : int32
colIndex : int32
sheet : FsWorksheet
Returns: FsCell

FsWorksheet.getColumnAt columnIndex sheet

Full Usage: FsWorksheet.getColumnAt columnIndex sheet

Parameters:
Returns: FsColumn

Returns the FsColumn at the given columnIndex of an FsWorksheet.

columnIndex : int
sheet : FsWorksheet
Returns: FsColumn

FsWorksheet.getColumns sheet

Full Usage: FsWorksheet.getColumns sheet

Parameters:
Returns: FsColumn seq

Returns the FsColumns of a given FsWorksheet.

sheet : FsWorksheet
Returns: FsColumn seq

FsWorksheet.getMaxRowIndex sheet

Full Usage: FsWorksheet.getMaxRowIndex sheet

Parameters:
Returns: FsRow

Returns the highest index of any FsRow in a given FsWorksheet.

sheet : FsWorksheet
Returns: FsRow

FsWorksheet.getRowAt rowIndex sheet

Full Usage: FsWorksheet.getRowAt rowIndex sheet

Parameters:
Returns: FsRow

Returns the FsRow at the given rowIndex of an FsWorksheet.

rowIndex : int
sheet : FsWorksheet
Returns: FsRow

FsWorksheet.getRowValuesAt rowIndex sheet

Full Usage: FsWorksheet.getRowValuesAt rowIndex sheet

Parameters:
Returns: obj seq

Gets the string values of the FsRow at the given 1-based rowIndex of a given FsWorksheet.

rowIndex : int
sheet : FsWorksheet
Returns: obj seq

FsWorksheet.getRows sheet

Full Usage: FsWorksheet.getRows sheet

Parameters:
Returns: ResizeArray<FsRow>

Returns the FsRows of a given FsWorksheet.

sheet : FsWorksheet
Returns: ResizeArray<FsRow>

FsWorksheet.getTableByName tableName sheet

Full Usage: FsWorksheet.getTableByName tableName sheet

Parameters:
Returns: FsTable

Returns the FsTable of the given name from an FsWorksheet.

tableName : string
sheet : FsWorksheet
Returns: FsTable

FsWorksheet.init name

Full Usage: FsWorksheet.init name

Parameters:
    name : string

Returns: FsWorksheet

Creates an empty FsWorksheet with the given name.

name : string
Returns: FsWorksheet

FsWorksheet.insertBefore row refRow sheet

Full Usage: FsWorksheet.insertBefore row refRow sheet

Parameters:
Returns: FsWorksheet

Inserts an FsRow into the FsWorksheet before a reference FsRow.

row : FsRow
refRow : FsRow
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.insertValueAt value rowIndex colIndex sheet

Full Usage: FsWorksheet.insertValueAt value rowIndex colIndex sheet

Parameters:
    value : 'a
    rowIndex : int
    colIndex : int
    sheet : FsWorksheet

Adds a value at the given row- and columnIndex to a given FsWorksheet. If an FsCell exists at the given position, it is shoved to the right.

value : 'a
rowIndex : int
colIndex : int
sheet : FsWorksheet

FsWorksheet.mapRowsInPlace f sheet

Full Usage: FsWorksheet.mapRowsInPlace f sheet

Parameters:
Returns: FsWorksheet

Applies function f in a given FsWorksheet to all FsRows and returns the modified FsWorksheet.

f : FsRow -> FsRow
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.removeCellAt rowIndex colIndex sheet

Full Usage: FsWorksheet.removeCellAt rowIndex colIndex sheet

Parameters:
Returns: FsWorksheet

Removes the value at the given row- and columnIndex from an FsWorksheet.

rowIndex : int
colIndex : int
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.removeRowAt rowIndex sheet

Full Usage: FsWorksheet.removeRowAt rowIndex sheet

Parameters:
Returns: FsWorksheet

Removes the FsRow at a given rowIndex of an FsWorksheet.

rowIndex : int
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.removeValueAt rowIndex colIndex sheet

Full Usage: FsWorksheet.removeValueAt rowIndex colIndex sheet

Parameters:

Removes the value of an FsCell at given row- and columnIndex from the FsCollection of a given FsWorksheet.

rowIndex : int
colIndex : int
sheet : FsWorksheet
ArgumentNullException if rowIndex or columnIndex is null.
KeyNotFoundException if row or column at the given index does not exist.

FsWorksheet.setValueAt value rowIndex colIndex sheet

Full Usage: FsWorksheet.setValueAt value rowIndex colIndex sheet

Parameters:
    value : 'a
    rowIndex : int32
    colIndex : int32
    sheet : FsWorksheet

Returns: FsWorksheet

Adds a value at the given row- and columnIndex of a given FsWorksheet. If an FsCell exists at the given position, it is overwritten.

value : 'a
rowIndex : int32
colIndex : int32
sheet : FsWorksheet
Returns: FsWorksheet

FsWorksheet.tryGetCellAt rowIndex colIndex sheet

Full Usage: FsWorksheet.tryGetCellAt rowIndex colIndex sheet

Parameters:
    rowIndex : int32
    colIndex : int32
    sheet : FsWorksheet

Returns: FsCell option

Returns the FsCell at the given row- and columnIndex of a given FsWorksheet if the FsCell exists, else returns None.

rowIndex : int32
colIndex : int32
sheet : FsWorksheet
Returns: FsCell option

FsWorksheet.tryGetColumnAt columnIndex sheet

Full Usage: FsWorksheet.tryGetColumnAt columnIndex sheet

Parameters:
Returns: FsColumn option

Returns the FsColumn at the given columnIndex of an FsWorksheet if it exists, else returns None.

columnIndex : int
sheet : FsWorksheet
Returns: FsColumn option

FsWorksheet.tryGetRowAfter rowIndex sheet

Full Usage: FsWorksheet.tryGetRowAfter rowIndex sheet

Parameters:
Returns: FsRow option

Returns the FsRow matching or exceeding the given rowIndex if it exists, else returns None.

rowIndex : int
sheet : FsWorksheet
Returns: FsRow option

FsWorksheet.tryGetRowAt rowIndex sheet

Full Usage: FsWorksheet.tryGetRowAt rowIndex sheet

Parameters:
Returns: FsRow option

Returns the FsRow at the given rowIndex of an FsWorksheet if it exists, else returns None.

rowIndex : int
sheet : FsWorksheet
Returns: FsRow option

FsWorksheet.tryGetRowValuesAt rowIndex sheet

Full Usage: FsWorksheet.tryGetRowValuesAt rowIndex sheet

Parameters:
Returns: obj seq option

Takes an FsWorksheet and gets the string values at the given 1-based rowIndex of the FsRow if it exists, else returns None.

rowIndex : int
sheet : FsWorksheet
Returns: obj seq option

FsWorksheet.tryGetTableByName tableName sheet

Full Usage: FsWorksheet.tryGetTableByName tableName sheet

Parameters:
Returns: FsTable option

Returns the FsTable of the given name from an FsWorksheet if it exists. Else returns None.

tableName : string
sheet : FsWorksheet
Returns: FsTable option

FsWorksheet.tryRemoveAt rowIndex sheet

Full Usage: FsWorksheet.tryRemoveAt rowIndex sheet

Parameters:

Removes the FsRow at a given rowIndex of an FsWorksheet if the FsRow exists.

rowIndex : int
sheet : FsWorksheet

FsWorksheet.tryRemoveValueAt rowIndex colIndex sheet

Full Usage: FsWorksheet.tryRemoveValueAt rowIndex colIndex sheet

Parameters:

Removes the value of an FsCell at given row- and columnIndex if it exists from the FsCollection of a given FsWorksheet.

Does nothing if the row or column of given index does not exist.

rowIndex : int
colIndex : int
sheet : FsWorksheet
ArgumentNullException if columnIndex is null.

FsWorksheet.validateForWrite ws

Full Usage: FsWorksheet.validateForWrite ws

Parameters:

Validate the FsWorksheet for writign to xlsx file.

ws : FsWorksheet

Type something to start searching.