Sheet (FsSpreadsheet) | FsSpreadsheet

FsSpreadsheet

Sheet Module

Namespace: FsSpreadsheet.Net
Assembly: FsSpreadsheet.Net.dll

Part of the Workbook, stores name and other additional info of the sheet. (Unmanaged: Changing a sheet does not alter the associated worksheet which stores the data)

Nested modules

Modules	Description
Sheets	Functions for working with Sheets.

Functions and values

Function or value	Description
`add spreadsheetDocument sheet` Full Usage: `add spreadsheetDocument sheet` Parameters: spreadsheetDocument : `SpreadsheetDocument` sheet : `Sheet` Returns: `SpreadsheetDocument`	Adds the given sheet to the spreadsheetDocument. spreadsheetDocument : `SpreadsheetDocument` sheet : `Sheet` Returns: `SpreadsheetDocument`
`countSheets spreadsheetDocument` Full Usage: `countSheets spreadsheetDocument` Parameters: spreadsheetDocument : `SpreadsheetDocument` Returns: `int`	Counts the number of sheets in the spreadsheetDocument. spreadsheetDocument : `SpreadsheetDocument` Returns: `int`
`create id name sheetID` Full Usage: `create id name sheetID` Parameters: id : `string` name : `string` sheetID : `uint32` Returns: `Sheet`	Create a sheet from the id, the name and the sheetID. id : `string` name : `string` sheetID : `uint32` Returns: `Sheet`
`empty ()` Full Usage: `empty ()` Parameters: () : `unit` Returns: `Sheet`	Creates an empty Sheet. () : `unit` Returns: `Sheet`
`getID sheet` Full Usage: `getID sheet` Parameters: sheet : `Sheet` Returns: `string`	Gets the ID of the sheet (this ID associates the sheet with the worksheet). sheet : `Sheet` Returns: `string`
`getName sheet` Full Usage: `getName sheet` Parameters: sheet : `Sheet` Returns: `string`	Gets the name of the sheet (this is the name displayed in MS Excel). sheet : `Sheet` Returns: `string`
`getSheetIndex sheet` Full Usage: `getSheetIndex sheet` Parameters: sheet : `Sheet` Returns: `uint32`	Gets the SheetID of the sheet (this ID determines the position of the sheet tab in MS Excel). sheet : `Sheet` Returns: `uint32`
`remove spreadsheetDocument sheet` Full Usage: `remove spreadsheetDocument sheet` Parameters: spreadsheetDocument : `SpreadsheetDocument` sheet : `Sheet` Returns: `SpreadsheetDocument`	Removes the given sheet from the sheets. spreadsheetDocument : `SpreadsheetDocument` sheet : `Sheet` Returns: `SpreadsheetDocument`
`setID id sheet` Full Usage: `setID id sheet` Parameters: id : `string` sheet : `Sheet` Returns: `Sheet`	Sets the ID of the sheet (this ID associates the sheet with the worksheet). id : `string` sheet : `Sheet` Returns: `Sheet`
`setName name sheet` Full Usage: `setName name sheet` Parameters: name : `string` sheet : `Sheet` Returns: `Sheet`	Sets the name of the sheet (this is the name displayed in MS Excel). name : `string` sheet : `Sheet` Returns: `Sheet`
`setSheetIndex id sheet` Full Usage: `setSheetIndex id sheet` Parameters: id : `uint32` sheet : `Sheet` Returns: `Sheet`	Sets the SheetID of the sheet (this ID determines the position of the sheet tab in MS Excel). id : `uint32` sheet : `Sheet` Returns: `Sheet`
`tryFind predicate spreadsheetDocument` Full Usage: `tryFind predicate spreadsheetDocument` Parameters: predicate : `string -> string -> uint32 -> bool` spreadsheetDocument : `SpreadsheetDocument` Returns: `Sheet option`	Returns the sheet for which the predicate returns true (Id Name SheetID -> bool) predicate : `string -> string -> uint32 -> bool` spreadsheetDocument : `SpreadsheetDocument` Returns: `Sheet option`
`tryGetById id spreadsheetDocument` Full Usage: `tryGetById id spreadsheetDocument` Parameters: id : `string` spreadsheetDocument : `SpreadsheetDocument` Returns: `Sheet option`	Returns the with the given ID in the SpreadsheetDocument if it exists. Else returns None. id : `string` spreadsheetDocument : `SpreadsheetDocument` Returns: `Sheet option`
`tryItem index spreadsheetDocument` Full Usage: `tryItem index spreadsheetDocument` Parameters: index : `uint` spreadsheetDocument : `SpreadsheetDocument` Returns: `Sheet option`	Returns the item at the given index in the SpreadsheetDocument if it exists. Else returns None. SheetIndices are 1-based. index : `uint` spreadsheetDocument : `SpreadsheetDocument` Returns: `Sheet option`
`tryItemByName name spreadsheetDocument` Full Usage: `tryItemByName name spreadsheetDocument` Parameters: name : `string` spreadsheetDocument : `SpreadsheetDocument` Returns: `Sheet option`	Returns the item with the given name in the spreadsheetDocument if it exists. Else returns None. name : `string` spreadsheetDocument : `SpreadsheetDocument` Returns: `Sheet option`