Spreadsheet (FsSpreadsheet)

Spreadsheet Module

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

Functions for working the spreadsheet document.

Functions and values

Function or value	Description
`appendRowValuesToSheet sheetId rowValues` Full Usage: `appendRowValuesToSheet sheetId rowValues` Parameters: sheetId : `'a` rowValues : `'T seq` Returns: `SpreadsheetDocument`	sheetId : `'a` rowValues : `'T seq` Returns: `SpreadsheetDocument`
`close spreadsheet` Full Usage: `close spreadsheet` Parameters: spreadsheet : `SpreadsheetDocument`	Closes the FileStream to the spreadsheet. spreadsheet : `SpreadsheetDocument`
`deleteRowFromSheet sheetId rowId` Full Usage: `deleteRowFromSheet sheetId rowId` Parameters: sheetId : `'a` rowId : `'b` Returns: `SpreadsheetDocument`	sheetId : `'a` rowId : `'b` Returns: `SpreadsheetDocument`
`fromFile path isEditable` Full Usage: `fromFile path isEditable` Parameters: path : `string` isEditable : `bool` Returns: `SpreadsheetDocument`	Opens the spreadsheet located at the given path and initialized a FileStream. path : `string` isEditable : `bool` Returns: `SpreadsheetDocument`
`fromStream stream isEditable` Full Usage: `fromStream stream isEditable` Parameters: stream : `Stream` isEditable : `bool` Returns: `SpreadsheetDocument`	Opens the spreadsheet from the given FileStream. stream : `Stream` isEditable : `bool` Returns: `SpreadsheetDocument`
`getCellsBySheet sheet spreadsheetDocument skipSST` Full Usage: `getCellsBySheet sheet spreadsheetDocument skipSST` Parameters: sheet : `Sheet` spreadsheetDocument : `SpreadsheetDocument` skipSST : `bool` Returns: `Cell seq`	Returns a 1D-sequence of Cells for the given Sheet of the given SpreadsheetDocument. sheet : `Sheet` spreadsheetDocument : `SpreadsheetDocument` skipSST : `bool` Returns: `Cell seq`
`getCellsBySheetID sheetID spreadsheetDocument skipSST` Full Usage: `getCellsBySheetID sheetID spreadsheetDocument skipSST` Parameters: sheetID : `string` spreadsheetDocument : `SpreadsheetDocument` skipSST : `bool` Returns: `Cell seq`	Returns a 1D-sequence of Cells for the given sheetIndex of the given SpreadsheetDocument. SheetIndices are 1-based. sheetID : `string` spreadsheetDocument : `SpreadsheetDocument` skipSST : `bool` Returns: `Cell seq`
`getCellsBySheetIndex sheetIndex spreadsheetDocument skipSST` Full Usage: `getCellsBySheetIndex sheetIndex spreadsheetDocument skipSST` Parameters: sheetIndex : `uint` spreadsheetDocument : `SpreadsheetDocument` skipSST : `bool` Returns: `Cell seq`	Returns a 1D-sequence of Cells for the given sheetIndex of the given SpreadsheetDocument. SheetIndices are 1-based. sheetIndex : `uint` spreadsheetDocument : `SpreadsheetDocument` skipSST : `bool` Returns: `Cell seq`
`getOrInitSharedStringTablePart spreadsheetDocument` Full Usage: `getOrInitSharedStringTablePart spreadsheetDocument` Parameters: spreadsheetDocument : `SpreadsheetDocument` Returns: `SharedStringTablePart`	Gets the sharedStringTablePart. If it does not exist, creates a new one. spreadsheetDocument : `SpreadsheetDocument` Returns: `SharedStringTablePart`
`getRowsBySheetIndex sheetIndex spreadsheetDocument` Full Usage: `getRowsBySheetIndex sheetIndex spreadsheetDocument` Parameters: sheetIndex : `uint` spreadsheetDocument : `SpreadsheetDocument` Returns: `Row seq`	Returns a sequence of rows containing the cells for the given 0-based sheetIndex of the given spreadsheetDocument. sheetIndex : `uint` spreadsheetDocument : `SpreadsheetDocument` Returns: `Row seq`
`getSharedStringTable spreadsheetDocument` Full Usage: `getSharedStringTable spreadsheetDocument` Parameters: spreadsheetDocument : `SpreadsheetDocument` Returns: `SharedStringTable`	Gets the sharedStringTable of a spreadsheet. spreadsheetDocument : `SpreadsheetDocument` Returns: `SharedStringTable`
`getWorkbookPart spreadsheet` Full Usage: `getWorkbookPart spreadsheet` Parameters: spreadsheet : `SpreadsheetDocument` Returns: `WorkbookPart`	Gets the workbookPart of the spreadsheet. spreadsheet : `SpreadsheetDocument` Returns: `WorkbookPart`
`init sheetName path` Full Usage: `init sheetName path` Parameters: sheetName : `string` path : `string` Returns: `SpreadsheetDocument`	Initializes a new spreadsheet with an empty sheet at the given path. sheetName : `string` path : `string` Returns: `SpreadsheetDocument`
`initEmpty path` Full Usage: `initEmpty path` Parameters: path : `string` Returns: `SpreadsheetDocument`	Initializes a new empty spreadsheet at the given path. path : `string` Returns: `SpreadsheetDocument`
`initEmptyOnStream stream` Full Usage: `initEmptyOnStream stream` Parameters: stream : `Stream` Returns: `SpreadsheetDocument`	Initializes a new empty spreadsheet in the given stream. stream : `Stream` Returns: `SpreadsheetDocument`
`initOnStream sheetName stream` Full Usage: `initOnStream sheetName stream` Parameters: sheetName : `string` stream : `Stream` Returns: `SpreadsheetDocument`	Initializes a new spreadsheet with an empty sheet in the given stream. sheetName : `string` stream : `Stream` Returns: `SpreadsheetDocument`
`initWithSst sheetName path` Full Usage: `initWithSst sheetName path` Parameters: sheetName : `string` path : `string` Returns: `SpreadsheetDocument`	Initializes a new spreadsheet with an empty sheet and a sharedStringTable at the given path. sheetName : `string` path : `string` Returns: `SpreadsheetDocument`
`initWithSstOnStream sheetName stream` Full Usage: `initWithSstOnStream sheetName stream` Parameters: sheetName : `string` stream : `Stream` Returns: `SpreadsheetDocument`	Initializes a new spreadsheet with an empty sheet and a sharedStringTable in the given stream. sheetName : `string` stream : `Stream` Returns: `SpreadsheetDocument`
`initWorkbookPart spreadsheet` Full Usage: `initWorkbookPart spreadsheet` Parameters: spreadsheet : `SpreadsheetDocument` Returns: `WorkbookPart`	Initialized a new workbookPart in the spreadsheetDocument but only if there is none. spreadsheet : `SpreadsheetDocument` Returns: `WorkbookPart`
`insertRowValuesIntoSheetAt sheetId rowId rowValues` Full Usage: `insertRowValuesIntoSheetAt sheetId rowId rowValues` Parameters: sheetId : `'a` rowId : `'b` rowValues : `'T seq` Returns: `SpreadsheetDocument`	sheetId : `'a` rowId : `'b` rowValues : `'T seq` Returns: `SpreadsheetDocument`
`insertValueIntoSheetAt sheetId rowId colId value` Full Usage: `insertValueIntoSheetAt sheetId rowId colId value` Parameters: sheetId : `'a` rowId : `'b` colId : `'c` value : `'T` Returns: `SpreadsheetDocument`	sheetId : `'a` rowId : `'b` colId : `'c` value : `'T` Returns: `SpreadsheetDocument`
`mapRowOfSheet sheetId rowId rowF` Full Usage: `mapRowOfSheet sheetId rowId rowF` Parameters: sheetId : `'a` rowId : `'b` rowF : `Row -> Row` Returns: `SpreadsheetDocument`	sheetId : `'a` rowId : `'b` rowF : `Row -> Row` Returns: `SpreadsheetDocument`
`mapRowsOfSheet sheetId rowF` Full Usage: `mapRowsOfSheet sheetId rowF` Parameters: sheetId : `'a` rowF : `Row -> Row` Returns: `SpreadsheetDocument`	sheetId : `'a` rowF : `Row -> Row` Returns: `SpreadsheetDocument`
`saveAs path spreadsheet` Full Usage: `saveAs path spreadsheet` Parameters: path : `string` spreadsheet : `SpreadsheetDocument` Returns: `SpreadsheetDocument`	Saves changes made to the spreadsheet to the given path. path : `string` spreadsheet : `SpreadsheetDocument` Returns: `SpreadsheetDocument`
`saveChanges spreadsheet` Full Usage: `saveChanges spreadsheet` Parameters: spreadsheet : `SpreadsheetDocument` Returns: `SpreadsheetDocument`	Saves changes made to the spreadsheet. spreadsheet : `SpreadsheetDocument` Returns: `SpreadsheetDocument`
`setValueInSheetAt sheetId rowId colId value` Full Usage: `setValueInSheetAt sheetId rowId colId value` Parameters: sheetId : `'a` rowId : `'b` colId : `'c` value : `'T` Returns: `SpreadsheetDocument`	sheetId : `'a` rowId : `'b` colId : `'c` value : `'T` Returns: `SpreadsheetDocument`
`tryGetSharedStringTable spreadsheetDocument` Full Usage: `tryGetSharedStringTable spreadsheetDocument` Parameters: spreadsheetDocument : `SpreadsheetDocument` Returns: `SharedStringTable option`	Gets the sharedStringTable of the spreadsheet if it exists, else returns None. spreadsheetDocument : `SpreadsheetDocument` Returns: `SharedStringTable option`
`tryGetSheetBySheetIndex sheetIndex spreadsheetDocument` Full Usage: `tryGetSheetBySheetIndex sheetIndex spreadsheetDocument` Parameters: sheetIndex : `uint` spreadsheetDocument : `SpreadsheetDocument` Returns: `SheetData option`	Returns the sheetData for the given 0-based sheetIndex of the given spreadsheetDocument. sheetIndex : `uint` spreadsheetDocument : `SpreadsheetDocument` Returns: `SheetData option`
`tryGetSheetBySheetName name spreadsheetDocument` Full Usage: `tryGetSheetBySheetName name spreadsheetDocument` Parameters: name : `string` spreadsheetDocument : `SpreadsheetDocument` Returns: `SheetData option`	Returns the sheetData for the given 0-based sheetIndex of the given spreadsheetDocument if it exists. Else returns None. name : `string` spreadsheetDocument : `SpreadsheetDocument` Returns: `SheetData option`
`tryGetWorksheetPartBySheetIndex sheetIndex spreadsheetDocument` Full Usage: `tryGetWorksheetPartBySheetIndex sheetIndex spreadsheetDocument` Parameters: sheetIndex : `uint` spreadsheetDocument : `SpreadsheetDocument` Returns: `WorksheetPart option`	Returns the worksheetPart for the given 0-based sheetIndex of the given spreadsheetDocument. sheetIndex : `uint` spreadsheetDocument : `SpreadsheetDocument` Returns: `WorksheetPart option`
`tryGetWorksheetPartBySheetName name spreadsheetDocument` Full Usage: `tryGetWorksheetPartBySheetName name spreadsheetDocument` Parameters: name : `string` spreadsheetDocument : `SpreadsheetDocument` Returns: `WorksheetPart option`	Returns the worksheetPart associated to the sheet with the given name. name : `string` spreadsheetDocument : `SpreadsheetDocument` Returns: `WorksheetPart option`