Cell (FsSpreadsheet)

Cell Module

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

Functions for creating and manipulating Cells.

Nested modules

Modules	Description
CellValue	Functions for manipulating CellValues.

Functions and values

Function or value	Description
`cellValuesToDataType cellValue` Full Usage: `cellValuesToDataType cellValue` Parameters: cellValue : `CellValues` Returns: `DataType`	Takes a CellValue and returns the appropriate DataType. DataType is the FsSpreadsheet representation of the CellValue enum in OpenXml. cellValue : `CellValues` Returns: `DataType`
`create dataType reference value` Full Usage: `create dataType reference value` Parameters: dataType : `CellValues option` reference : `string` value : `CellValue` Returns: `Cell`	Creates a Cell from a CellValues type case, a "A1" style reference, and a CellValue containing the value string. dataType : `CellValues option` reference : `string` value : `CellValue` Returns: `Cell`
`createWithFormat doc dataType reference cellFormat value` Full Usage: `createWithFormat doc dataType reference cellFormat value` Parameters: doc : `SpreadsheetDocument` dataType : `CellValues option` reference : `string` cellFormat : `CellFormat` value : `CellValue` Returns: `Cell`	Creates a Cell from a CellValues type case, a "A1" style reference, and a CellValue containing the value string. doc : `SpreadsheetDocument` dataType : `CellValues option` reference : `string` cellFormat : `CellFormat` value : `CellValue` Returns: `Cell`
`empty ()` Full Usage: `empty ()` Parameters: () : `unit` Returns: `Cell`	Creates an empty Cell. () : `unit` Returns: `Cell`
`fromValue sharedStringTable columnIndex rowIndex value` Full Usage: `fromValue sharedStringTable columnIndex rowIndex value` Parameters: sharedStringTable : `Option<SharedStringTable>` columnIndex : `uint32` rowIndex : `uint32` value : `'T` Returns: `Cell`	Create a cell using a shared string table, also returns the updated shared string table. sharedStringTable : `Option<SharedStringTable>` columnIndex : `uint32` rowIndex : `uint32` value : `'T` Returns: `Cell`
`fromValueWithDataType doc columnIndex rowIndex value dataType` Full Usage: `fromValueWithDataType doc columnIndex rowIndex value dataType` Parameters: doc : `SpreadsheetDocument` columnIndex : `uint32` rowIndex : `uint32` value : `string` dataType : `DataType` Returns: `Cell`	Create a cell using a shared string table, also returns the updated shared string table. doc : `SpreadsheetDocument` columnIndex : `uint32` rowIndex : `uint32` value : `string` dataType : `DataType` Returns: `Cell`
`getCellContent doc value dataType` Full Usage: `getCellContent doc value dataType` Parameters: doc : `SpreadsheetDocument` value : `string` dataType : `DataType` Returns: `(type)`	doc : `SpreadsheetDocument` value : `string` dataType : `DataType` Returns: `(type)`
`getCellValue cell` Full Usage: `getCellValue cell` Parameters: cell : `Cell` Returns: `CellValue`	Gets the CellValue. cell : `Cell` Returns: `CellValue`
`getReference cell` Full Usage: `getReference cell` Parameters: cell : `Cell` Returns: `string`	Gets "A1"-style Cell reference. cell : `Cell` Returns: `string`
`getType cell` Full Usage: `getType cell` Parameters: cell : `Cell` Returns: `CellValues`	Gets a Cell type. cell : `Cell` Returns: `CellValues`
`getValue sharedStringTable cell` Full Usage: `getValue sharedStringTable cell` Parameters: sharedStringTable : `Option<SST>` cell : `Cell` Returns: `string`	Maps a Cell to the value string using a sharedStringTable. sharedStringTable : `Option<SST>` cell : `Cell` Returns: `string`
`includeSharedStringValue sharedStringTable cell` Full Usage: `includeSharedStringValue sharedStringTable cell` Parameters: sharedStringTable : `SST` cell : `Cell` Returns: `Cell`	Includes a value from the sharedStringTable in Cell.CellValue.Text. sharedStringTable : `SST` cell : `Cell` Returns: `Cell`
`inferCellValue value` Full Usage: `inferCellValue value` Parameters: value : `'T` Returns: `CellValues * string`	Returns the proper CellValues case for the given value. value : `'T` Returns: `CellValues * string`
`setReference reference cell` Full Usage: `setReference reference cell` Parameters: reference : `string` cell : `Cell` Returns: `Cell`	Sets "A1"-style Cell reference. reference : `string` cell : `Cell` Returns: `Cell`
`setSpacePreserveAttribute c` Full Usage: `setSpacePreserveAttribute c` Parameters: c : `Cell` Returns: `Cell`	Sets the preserve attribute of a Cell. c : `Cell` Returns: `Cell`
`setType dataType cell` Full Usage: `setType dataType cell` Parameters: dataType : `CellValues` cell : `Cell` Returns: `Cell`	Sets a Cell type. dataType : `CellValues` cell : `Cell` Returns: `Cell`
`setValue value cell` Full Usage: `setValue value cell` Parameters: value : `CellValue` cell : `Cell` Returns: `Cell`	Sets a CellValue. value : `CellValue` cell : `Cell` Returns: `Cell`
`tryGetCellValue cell` Full Usage: `tryGetCellValue cell` Parameters: cell : `Cell` Returns: `CellValue option`	Gets Some CellValue if cellValue is existent. Else returns None. cell : `Cell` Returns: `CellValue option`
`tryGetType cell` Full Usage: `tryGetType cell` Parameters: cell : `Cell` Returns: `CellValues option`	Gets Some type if existent. Else returns None. cell : `Cell` Returns: `CellValues option`
`tryGetValue sharedStringTable cell` Full Usage: `tryGetValue sharedStringTable cell` Parameters: sharedStringTable : `Option<SST>` cell : `Cell` Returns: `string option`	Maps a Cell to the value string using a shared string table. sharedStringTable : `Option<SST>` cell : `Cell` Returns: `string option`