WorkbookPart (FsSpreadsheet) | FsSpreadsheet

FsSpreadsheet

WorkbookPart Module

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

Functions for working with WorkbookParts.

Functions and values

Function or value	Description
`addWorksheetPart worksheetPart workbookPart` Full Usage: `addWorksheetPart worksheetPart workbookPart` Parameters: worksheetPart : `WorksheetPart` workbookPart : `WorkbookPart` Returns: `WorksheetPart`	Add a WorksheetPart to the WorkbookPart. worksheetPart : `WorksheetPart` workbookPart : `WorkbookPart` Returns: `WorksheetPart`
`appendSheet sheetName data workbookPart` Full Usage: `appendSheet sheetName data workbookPart` Parameters: sheetName : `string` data : `SheetData` workbookPart : `WorkbookPart` Returns: `WorkbookPart`	Appends a new sheet with the given SheetData to the SpreadsheetDocument. sheetName : `string` data : `SheetData` workbookPart : `WorkbookPart` Returns: `WorkbookPart`
`appendWorksheet sheetName worksheet workbookPart` Full Usage: `appendWorksheet sheetName worksheet workbookPart` Parameters: sheetName : `string` worksheet : `Worksheet` workbookPart : `WorkbookPart` Returns: `WorkbookPart`	Appends a worksheet to the SpreadsheetDocument. sheetName : `string` worksheet : `Worksheet` workbookPart : `WorkbookPart` Returns: `WorkbookPart`
`containsSharedStringTablePart workbookPart` Full Usage: `containsSharedStringTablePart workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `bool`	Returns true if the WorkbookPart contains a SharedStringTablePart. workbookPart : `WorkbookPart` Returns: `bool`
`containsWorkSheetParts workbookPart` Full Usage: `containsWorkSheetParts workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `bool`	Returns true if the WorkbookPart contains at least one WorksheetPart. workbookPart : `WorkbookPart` Returns: `bool`
`getDataOfFirstSheet workbookPart` Full Usage: `getDataOfFirstSheet workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `SheetData`	Returns the SheetData of the first sheet of the given WorkbookPart. workbookPart : `WorkbookPart` Returns: `SheetData`
`getOrInitSharedStringTablePart workbookPart` Full Usage: `getOrInitSharedStringTablePart workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `SharedStringTablePart`	Returns the existing or a newly created SharedStringTablePart associated with the WorkbookPart. workbookPart : `WorkbookPart` Returns: `SharedStringTablePart`
`getOrInitWorksheetPartByName sheetName workbookPart` Full Usage: `getOrInitWorksheetPartByName sheetName workbookPart` Parameters: sheetName : `string` workbookPart : `WorkbookPart` Returns: `WorksheetPart`	Appends a worksheet to the SpreadsheetDocument. sheetName : `string` workbookPart : `WorkbookPart` Returns: `WorksheetPart`
`getSharedStringTable workbookPart` Full Usage: `getSharedStringTable workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `SharedStringTable`	Returns the SharedStringTable of a WorkbookPart. workbookPart : `WorkbookPart` Returns: `SharedStringTable`
`getSharedStringTablePart workbookPart` Full Usage: `getSharedStringTablePart workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `SharedStringTablePart`	Gets the SharedStringTablePart of a WorkbookPart. workbookPart : `WorkbookPart` Returns: `SharedStringTablePart`
`getWorkSheetParts workbookPart` Full Usage: `getWorkSheetParts workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `IEnumerable<WorksheetPart>`	Get the WorksheetParts of the WorkbookPart. workbookPart : `WorkbookPart` Returns: `IEnumerable<WorksheetPart>`
`getWorksheetPartById id workbookPart` Full Usage: `getWorksheetPartById id workbookPart` Parameters: id : `string` workbookPart : `WorkbookPart` Returns: `WorksheetPart`	Gets the WorksheetPart of the WorkbookPart with the given ID. id : `string` workbookPart : `WorkbookPart` Returns: `WorksheetPart`
`getWorksheetPartID worksheetPart workbookPart` Full Usage: `getWorksheetPartID worksheetPart workbookPart` Parameters: worksheetPart : `WorksheetPart` workbookPart : `WorkbookPart` Returns: `string`	Gets the ID of the WorksheetPart of the WorkbookPart. worksheetPart : `WorksheetPart` workbookPart : `WorkbookPart` Returns: `string`
`initSharedStringTablePart workbookPart` Full Usage: `initSharedStringTablePart workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `WorkbookPart`	Sets an empty SharedStringTablePart in the given WorkbookPart. workbookPart : `WorkbookPart` Returns: `WorkbookPart`
`initWorksheetPart workbookPart` Full Usage: `initWorksheetPart workbookPart` Parameters: workbookPart : `WorkbookPart` Returns: `WorksheetPart`	Add an empty WorksheetPart to the WorkbookPart. workbookPart : `WorkbookPart` Returns: `WorksheetPart`
`replaceSheetDataByName sheetName data workbookPart` Full Usage: `replaceSheetDataByName sheetName data workbookPart` Parameters: sheetName : `string` data : `SheetData` workbookPart : `WorkbookPart` Returns: `WorkbookPart`	Replaces the SheetData of the Sheet with the given sheetname. sheetName : `string` data : `SheetData` workbookPart : `WorkbookPart` Returns: `WorkbookPart`
`tryGetWorksheetPartById id workbookPart` Full Usage: `tryGetWorksheetPartById id workbookPart` Parameters: id : `string` workbookPart : `WorkbookPart` Returns: `WorksheetPart option`	If the WorkbookPart contains the WorksheetPart with the given ID, returns it. Else returns None. id : `string` workbookPart : `WorkbookPart` Returns: `WorksheetPart option`