Header menu logo FsSpreadsheet

Sheets Module

Functions for working with Sheets.

Functions and values

Function or value Description

addSheet newSheet sheets

Full Usage: addSheet newSheet sheets

Parameters:
Returns: Sheet

Adds a single Sheet to the Sheets.

newSheet : Sheet
sheets : Sheets
Returns: Sheet

addSheets newSheets sheets

Full Usage: addSheets newSheets sheets

Parameters:
Returns: Sheets

Adds a Sheet collection to the Sheets.

newSheets : Sheet seq
sheets : Sheets
Returns: Sheets

empty ()

Full Usage: empty ()

Parameters:
    () : unit

Returns: Sheets

Creates empty sheets.

() : unit
Returns: Sheets

get workbook

Full Usage: get workbook

Parameters:
Returns: Sheets

Gets the sheets of the workbook.

workbook : Workbook
Returns: Sheets

getFirstSheet sheets

Full Usage: getFirstSheet sheets

Parameters:
Returns: Sheet

Returns the first child sheet of the sheets.

sheets : Sheets
Returns: Sheet

getOrInit workbook

Full Usage: getOrInit workbook

Parameters:
Returns: Sheets

Returns the existing or a newly created sheets associated with the worksheet.

workbook : Workbook
Returns: Sheets

getSheets sheets

Full Usage: getSheets sheets

Parameters:
Returns: IEnumerable<Sheet>

Returns all sheets of the sheets.

sheets : Sheets
Returns: IEnumerable<Sheet>

init workbook

Full Usage: init workbook

Parameters:
Returns: Workbook

Add an empty sheets element to the workbook.

workbook : Workbook
Returns: Workbook

tryGetSheetByName name sheets

Full Usage: tryGetSheetByName name sheets

Parameters:
    name : string
    sheets : Sheets

Returns: Sheet option
name : string
sheets : Sheets
Returns: Sheet option

Type something to start searching.