SharedStringTable (FsSpreadsheet) | FsSpreadsheet

FsSpreadsheet

SharedStringTable Module

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

Functions for working with SharedStringTables.

Nested modules

Modules	Description
SharedStringItem	Functions for working with SharedStringItems.

Functions and values

Function or value	Description
`append sharedStringItem sharedStringTable` Full Usage: `append sharedStringItem sharedStringTable` Parameters: sharedStringItem : `SharedStringItem` sharedStringTable : `SharedStringTable` Returns: `SharedStringTable`	Appends the SharedStringItem to the end of the SharedStringTable. sharedStringItem : `SharedStringItem` sharedStringTable : `SharedStringTable` Returns: `SharedStringTable`
`count sst` Full Usage: `count sst` Parameters: sst : `SharedStringTable` Returns: `uint32`	Number of sharedStringItems in the sharedStringTable. sst : `SharedStringTable` Returns: `uint32`
`empty ()` Full Usage: `empty ()` Parameters: () : `unit` Returns: `SharedStringTable`	Creates an empty sharedStringTable. () : `unit` Returns: `SharedStringTable`
`get sstPart` Full Usage: `get sstPart` Parameters: sstPart : `SharedStringTablePart` Returns: `SharedStringTable`	Gets the sharedStringTable of the sharedStringTablePart. sstPart : `SharedStringTablePart` Returns: `SharedStringTable`
`getIndexByString text sst` Full Usage: `getIndexByString text sst` Parameters: text : `string` sst : `SharedStringTable` Returns: `int`	Returns the index of the string, or the invers of the element count. text : `string` sst : `SharedStringTable` Returns: `int`
`getText i sst` Full Usage: `getText i sst` Parameters: i : `int` sst : `SharedStringTable` Returns: `SharedStringItem`	Returns the sharedStringItem at the given index. i : `int` sst : `SharedStringTable` Returns: `SharedStringItem`
`init sstPart` Full Usage: `init sstPart` Parameters: sstPart : `SharedStringTablePart` Returns: `SharedStringTablePart`	Sets an empty sharedStringTable. sstPart : `SharedStringTablePart` Returns: `SharedStringTablePart`
`insertText text sharedStringTable` Full Usage: `insertText text sharedStringTable` Parameters: text : `string` sharedStringTable : `SharedStringTable` Returns: `int`	Inserts text into the sharedStringTable. If the item already exists, returns its index. text : `string` sharedStringTable : `SharedStringTable` Returns: `int`
`set sst sstPart` Full Usage: `set sst sstPart` Parameters: sst : `SharedStringTable` sstPart : `SharedStringTablePart` Returns: `SharedStringTablePart`	Sets the sharedStringtable of the sharedStringTablePart. sst : `SharedStringTable` sstPart : `SharedStringTablePart` Returns: `SharedStringTablePart`
`toSST sst` Full Usage: `toSST sst` Parameters: sst : `SharedStringTable` Returns: `string array`	sst : `SharedStringTable` Returns: `string array`
`toSeq sst` Full Usage: `toSeq sst` Parameters: sst : `SharedStringTable` Returns: `SharedStringItem seq`	Returns the sharedStringItems contained in the sharedStringTable. sst : `SharedStringTable` Returns: `SharedStringItem seq`
`tryGet spreadsheetDocument` Full Usage: `tryGet spreadsheetDocument` Parameters: spreadsheetDocument : `SpreadsheetDocument` Returns: `SharedStringTable option`	Gets the sharedStringTable of the spreadsheet if it exists, else returns None. spreadsheetDocument : `SpreadsheetDocument` Returns: `SharedStringTable option`
`tryGetIndexByString s sst` Full Usage: `tryGetIndexByString s sst` Parameters: s : `string` sst : `SharedStringTable` Returns: `int option`	If the string is contained in the sharedStringTable, contains the index of its position. s : `string` sst : `SharedStringTable` Returns: `int option`