Header menu logo FsSpreadsheet

FsWorkbook Type

Namespace: FsSpreadsheet
Assembly: FsSpreadsheet.dll
Base Type: obj
All Interfaces: IDisposable

Creates an empty FsWorkbook.

Constructors

Constructor Description

FsWorkbook()

Full Usage: FsWorkbook()

Returns: FsWorkbook
Returns: FsWorkbook

Instance members

Instance member Description

this.AddWorksheet

Full Usage: this.AddWorksheet

Parameters:

Adds a given FsWorksheet to the FsWorkbook.

sheet : FsWorksheet

this.AddWorksheets

Full Usage: this.AddWorksheets

Parameters:

Adds a collection of FsWorksheets to the FsWorkbook.

sheets : FsWorksheet seq

this.Copy

Full Usage: this.Copy

Returns: FsWorkbook

Creates a deep copy of this FsWorkbook.

Returns: FsWorkbook

this.GetTables

Full Usage: this.GetTables

Returns: FsTable array

Returns all FsTables from the FsWorkbook.

Returns: FsTable array

this.GetWorksheetAt

Full Usage: this.GetWorksheetAt

Parameters:
    index : int

Returns: FsWorksheet

Returns the FsWorksheet with the given 1 based index.

index : int
Returns: FsWorksheet
Exception if FsWorksheet with at position is not present in the FsWorkkbook.

this.GetWorksheetByName

Full Usage: this.GetWorksheetByName

Parameters:
    sheetName : string

Returns: FsWorksheet

Returns the FsWorksheet with the given name.

sheetName : string
Returns: FsWorksheet
Exception if FsWorksheet with given name is not present in the FsWorkkbook.

this.GetWorksheets

Full Usage: this.GetWorksheets

Returns: ResizeArray<FsWorksheet>

Returns all FsWorksheets.

Returns: ResizeArray<FsWorksheet>

this.InitWorksheet

Full Usage: this.InitWorksheet

Parameters:
    name : string

Returns: FsWorksheet

Creates an empty FsWorksheet with given name and adds it to the FsWorkbook.

name : string
Returns: FsWorksheet

this.RemoveWorksheet

Full Usage: this.RemoveWorksheet

Parameters:
    name : string

Removes an FsWorksheet with given name.

name : string
Exception if FsWorksheet with given name is not present in the FsWorkkbook.

this.TryGetWorksheetAt

Full Usage: this.TryGetWorksheetAt

Parameters:
    index : int

Returns: FsWorksheet option

Returns the FsWorksheet with the given 1 based index if it exists. Else returns None.

index : int
Returns: FsWorksheet option

this.TryGetWorksheetByName

Full Usage: this.TryGetWorksheetByName

Parameters:
    sheetName : string

Returns: FsWorksheet option

Returns the FsWorksheet with the given name if it exists in the FsWorkbook. Else returns None.

sheetName : string
Returns: FsWorksheet option

Static members

Static member Description

FsWorkbook.addWorksheet sheet workbook

Full Usage: FsWorkbook.addWorksheet sheet workbook

Parameters:
Returns: FsWorkbook

Adds an FsWorksheet to an FsWorkbook.

sheet : FsWorksheet
workbook : FsWorkbook
Returns: FsWorkbook

FsWorkbook.addWorksheets sheets workbook

Full Usage: FsWorkbook.addWorksheets sheets workbook

Parameters:
Returns: FsWorkbook

Adds a collection of FsWorksheets to an FsWorkbook.

sheets : FsWorksheet seq
workbook : FsWorkbook
Returns: FsWorkbook

FsWorkbook.copy workbook

Full Usage: FsWorkbook.copy workbook

Parameters:
Returns: FsWorkbook

Returns a deep copy of a given FsWorkbook.

workbook : FsWorkbook
Returns: FsWorkbook

FsWorkbook.getTables workbook

Full Usage: FsWorkbook.getTables workbook

Parameters:
Returns: FsTable array

Returns all FsTables from an FsWorkbook.

workbook : FsWorkbook
Returns: FsTable array

FsWorkbook.getWorksheetAt index workbook

Full Usage: FsWorkbook.getWorksheetAt index workbook

Parameters:
Returns: FsWorksheet

Returns the FsWorksheet with the given the given 1 based indexk.

index : int
workbook : FsWorkbook
Returns: FsWorksheet
Exception if FsWorksheet with at position is not present in the FsWorkkbook.

FsWorkbook.getWorksheetByName sheetName workbook

Full Usage: FsWorkbook.getWorksheetByName sheetName workbook

Parameters:
Returns: FsWorksheet

Returns the FsWorksheet with the given name from an FsWorkbook.

sheetName : string
workbook : FsWorkbook
Returns: FsWorksheet
Exception if FsWorksheet with given name is not present in the FsWorkkbook.

FsWorkbook.getWorksheets workbook

Full Usage: FsWorkbook.getWorksheets workbook

Parameters:
Returns: ResizeArray<FsWorksheet>

Returns all FsWorksheets.

workbook : FsWorkbook
Returns: ResizeArray<FsWorksheet>

FsWorkbook.initWorksheet name workbook

Full Usage: FsWorkbook.initWorksheet name workbook

Parameters:
Returns: FsWorksheet

Creates an empty FsWorksheet with given name and adds it to the FsWorkbook.

name : string
workbook : FsWorkbook
Returns: FsWorksheet

FsWorkbook.removeWorksheet name workbook

Full Usage: FsWorkbook.removeWorksheet name workbook

Parameters:
Returns: FsWorkbook

Removes an FsWorksheet with given name from an FsWorkbook.

name : string
workbook : FsWorkbook
Returns: FsWorkbook

FsWorkbook.tryGetWorksheetAt index workbook

Full Usage: FsWorkbook.tryGetWorksheetAt index workbook

Parameters:
Returns: FsWorksheet option

Returns the FsWorksheet with the given 1 based index if it exists in a given FsWorkbook. Else returns None.

index : int
workbook : FsWorkbook
Returns: FsWorksheet option

FsWorkbook.tryGetWorksheetByName sheetName workbook

Full Usage: FsWorkbook.tryGetWorksheetByName sheetName workbook

Parameters:
Returns: FsWorksheet option

Returns the FsWorksheet with the given name if it exists in a given FsWorkbook. Else returns None.

sheetName : string
workbook : FsWorkbook
Returns: FsWorksheet option

Type something to start searching.