Header menu logo FsSpreadsheet

Worksheet Module

Stores data of the sheet and the index of the sheet and functions for working with the worksheetpart. (Unmanaged: changing a worksheet does not alter the sheet which links the worksheet to the excel workbook)

Nested modules

Modules Description

Comments

Functions for working with Comments.

WorksheetCommentsPart

Functions for extracting / working with WorksheetCommentsParts.

WorksheetPart

Functions for extracting / working with WorksheetParts.

Functions and values

Function or value Description

addSheetData sheetData worksheet

Full Usage: addSheetData sheetData worksheet

Parameters:
Returns: Worksheet

Associates a SheetData with the Worksheet.

sheetData : SheetData
worksheet : Worksheet
Returns: Worksheet

empty ()

Full Usage: empty ()

Parameters:
    () : unit

Returns: Worksheet

Empty Worksheet

() : unit
Returns: Worksheet

get worksheetPart

Full Usage: get worksheetPart

Parameters:
Returns: Worksheet
worksheetPart : WorksheetPart
Returns: Worksheet

getOrInit worksheetPart

Full Usage: getOrInit worksheetPart

Parameters:
Returns: Worksheet

Returns the existing or a newly created Worksheet associated with the WorksheetPart.

worksheetPart : WorksheetPart
Returns: Worksheet

getSheetData worksheet

Full Usage: getSheetData worksheet

Parameters:
Returns: SheetData

Returns the sheetdata associated with the Worksheet.

worksheet : Worksheet
Returns: SheetData

hasSheetData worksheet

Full Usage: hasSheetData worksheet

Parameters:
Returns: bool

Returns true, if the Worksheet contains SheetData.

worksheet : Worksheet
Returns: bool

init worksheetPart

Full Usage: init worksheetPart

Parameters:
    worksheetPart : WorksheetPart - The WorksheetPart to associate the Worksheet with.

Returns: WorksheetPart

Associates an empty Worksheet with the WorksheetPart.

worksheetPart : WorksheetPart

The WorksheetPart to associate the Worksheet with.

Returns: WorksheetPart

ofSheetData sheetData

Full Usage: ofSheetData sheetData

Parameters:
Returns: Worksheet

Creates a Worksheet containing the given SheetData.

sheetData : SheetData
Returns: Worksheet

setSheetData sheetData worksheet

Full Usage: setSheetData sheetData worksheet

Parameters:
Returns: Worksheet

Sets the SheetData of a Worksheet.

sheetData : SheetData
worksheet : Worksheet
Returns: Worksheet

setWorksheet worksheet worksheetPart

Full Usage: setWorksheet worksheet worksheetPart

Parameters:
Returns: WorksheetPart

Sets the given Worksheet with the WorksheetPart.

worksheet : Worksheet
worksheetPart : WorksheetPart
Returns: WorksheetPart

Type something to start searching.