PicoXLSX Library Documentation
 | Workbook Class |
Class representing a workbook
Inheritance HierarchyNamespace: PicoXLSX
Assembly: PicoXLSX (in PicoXLSX.dll) Version: 2.4.0.0 (2.4.0)
SyntaxC#
public class Workbook
The Workbook type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Workbook(Boolean) |
Constructor with additional parameter to create a default worksheet. This constructor can be used to define a workbook that is saved as stream
|
| Workbook(String) |
Constructor with additional parameter to create a default worksheet with the specified name. This constructor can be used to define a workbook that is saved as stream
|
| Workbook(String, String) |
Constructor with filename ant the name of the first worksheet
|
| Workbook(String, String, Boolean) |
Constructor with filename ant the name of the first worksheet
|
Properties| Name | Description | |
|---|---|---|
 | CurrentWorksheet |
Gets the current worksheet
|
| Filename |
Gets or sets the filename of the workbook
|
| LockStructureIfProtected |
Gets whether the structure are locked if workbook is protected
|
| LockWindowsIfProtected |
Gets whether the windows are locked if workbook is protected
|
| SelectedWorksheet |
Gets the selected worksheet. The selected worksheet is not the current worksheet while design time but the selected sheet in the output file
|
| Styles |
Gets the style manager of this workbook
|
| UseWorkbookProtection |
Gets or sets whether the workbook is protected
|
| WorkbookMetadata |
Meta data object of the workbook
|
| WorkbookProtectionPassword |
Gets the password used for workbook protection
|
| Worksheets |
Gets the list of worksheets in the workbook
|
| WS |
Gets the shortener object for the current worksheet
|
Methods| Name | Description | |
|---|---|---|
| AddStyle |
Adds a style to the style manager
|
| AddStyleComponent |
Adds a style component to a style
|
| AddWorksheet(String) |
Adding a new Worksheet. The new worksheet will be defined as current worksheet
|
| AddWorksheet(Worksheet) |
Adding a new Worksheet. The new worksheet will be defined as current worksheet
|
| AddWorksheet(String, Boolean) |
Adding a new Worksheet with a sanitizing option. The new worksheet will be defined as current worksheet
|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | Init |
Init method called in the constructors
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RemoveStyle(String) |
Removes the defined style from the style sheet of the workbook
|
| RemoveStyle(Style) |
Removes the passed style from the style sheet
|
| RemoveStyle(String, Boolean) |
Removes the defined style from the style sheet of the workbook
|
| RemoveStyle(Style, Boolean) |
Removes the defined style from the style sheet of the workbook
|
| RemoveWorksheet |
Removes the defined worksheet
|
| ResolveMergedCells |
Method to resolve all merged cells in all worksheets. Only the value of the very first cell of the locked cells range will be visible. The other values are still present (set to EMPTY) but will not be stored in the worksheet.
|
| Save |
Saves the workbook
|
| SaveAs |
Saves the workbook with the defined name
|
| SaveAsStream |
Save the workbook to a writable stream
|
| SetCurrentWorksheet |
Sets the current worksheet
|
| SetSelectedWorksheet(Int32) |
Sets the selected worksheet in the output workbook
|
| SetSelectedWorksheet(Worksheet) |
Sets the selected worksheet in the output workbook
|
| SetWorkbookProtection |
Sets or removes the workbook protection. If protectWindows and protectStructure are both false, the workbook will not be protected
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also