 | Workbook Class |
Class representing a workbook
Inheritance HierarchySystemObject
NanoXLSXWorkbook
NanoXLSXWorkbook
Namespace: NanoXLSX
Assembly: NanoXLSX (in NanoXLSX.dll) Version: 2.6.2+7f12a949130e0be1e987e553d2d08c083176cdca
SyntaxC#
public class Workbook
The Workbook type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Workbook | Default constructor. No initial worksheet is created. Use AddWorksheet(String) (or overloads) to add one |
| 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. |
| Hidden | Gets or sets whether the whole workbook is hidden |
| LockStructureIfProtected | Gets whether the structure are locked if workbook is protected. See also SetWorkbookProtection(Boolean, Boolean, Boolean, String) |
| LockWindowsIfProtected | Gets whether the windows are locked if workbook is protected. See also SetWorkbookProtection(Boolean, Boolean, Boolean, String) |
| SelectedWorksheet | Gets the selected worksheet. The selected worksheet is not the current worksheet while design time but the selected sheet in the output file |
| UseWorkbookProtection | Gets or sets whether the workbook is protected |
| WorkbookMetadata | Meta data object of the workbook |
| WorkbookProtectionPassword | Gets the password used for workbook protection. See also SetWorkbookProtection(Boolean, Boolean, Boolean, String) |
| WorkbookProtectionPasswordHash | Hash of the protected workbook, originated from WorkbookProtectionPassword |
| Worksheets | Gets the list of worksheets in the workbook |
| WS | Gets the shortener object for the current worksheet |
Methods| Name | Description | |
|---|---|---|
| AddMruColor | Adds a color value (HEX; 6-digit RGB or 8-digit ARGB) to the MRU list |
| AddStyle | Obsolete. Adds a style to the style repository. This method is deprecated since it has no direct impact on the generated file. |
| AddStyleComponent | Obsolete. Adds a style component to a style. This method is deprecated since it has no direct impact on the generated file. |
| 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 |
| AddWorksheet(Worksheet, Boolean) | Adding a new Worksheet. The new worksheet will be defined as current worksheet |
| ClearMruColors | Clears the MRU color list |
| CopyWorksheetIntoThis(Int32, String, Boolean) | Copies a worksheet of the current workbook by its index |
| CopyWorksheetIntoThis(String, String, Boolean) | Copies a worksheet of the current workbook by its name |
| CopyWorksheetIntoThis(Worksheet, String, Boolean) | Copies a worksheet of any workbook into the current workbook |
| CopyWorksheetTo(Int32, String, Workbook, Boolean) | Copies a worksheet of the current workbook by its index into another workbook |
| CopyWorksheetTo(String, String, Workbook, Boolean) | Copies a worksheet of the current workbook by its name into another workbook |
 | CopyWorksheetTo(Worksheet, String, Workbook, Boolean) | Copies a worksheet of any workbook into the another workbook |
| Equals | Determines whether the specified object is equal to the current object. (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 the default hash function. (Inherited from Object) |
| GetMruColors | Gets the MRU color list |
 | GetNextWorksheetId | Gets the next free worksheet ID |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetWorksheet(Int32) | Gets a worksheet from this workbook by index |
| GetWorksheet(String) | Gets a worksheet from this workbook by name |
| Init | Init method called in the constructors |
| Load(Stream, ImportOptions) | Loads a workbook from a stream |
| Load(String, ImportOptions) | Loads a workbook from a file |
| LoadAsync(Stream, ImportOptions) | Loads a workbook from a stream asynchronously |
| LoadAsync(String, ImportOptions) | Loads a workbook from a file asynchronously |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RemoveStyle(String) | Obsolete. Removes the defined style from the style sheet of the workbook. This method is deprecated since it has no direct impact on the generated file. |
| RemoveStyle(Style) | Obsolete. Removes the passed style from the style sheet. This method is deprecated since it has no direct impact on the generated file. |
| RemoveStyle(String, Boolean) | Obsolete. Removes the defined style from the style sheet of the workbook. This method is deprecated since it has no direct impact on the generated file. |
| RemoveStyle(Style, Boolean) | Obsolete. Removes the defined style from the style sheet of the workbook |
| RemoveWorksheet(Int32) | Removes the defined worksheet based on its index. If the worksheet is the current or selected worksheet, the current and / or the selected worksheet will be set to the last worksheet of the workbook. If the last worksheet is removed, the selected worksheet will be set to 0 and the current worksheet to null. |
| RemoveWorksheet(String) | Removes the defined worksheet based on its name. If the worksheet is the current or selected worksheet, the current and / or the selected worksheet will be set to the last worksheet of the workbook. If the last worksheet is removed, the selected worksheet will be set to 0 and the current worksheet to null. |
| RemoveWorksheet(Int32, Boolean) | Removes the worksheet at the defined index and relocates current and selected worksheet references |
| 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. This is an internal method. There is no need to use it |
| Save | Saves the workbook |
| SaveAs | Saves the workbook with the defined name |
| SaveAsAsync | Saves the workbook with the defined name asynchronous. |
| SaveAsStream | Save the workbook to a writable stream |
| SaveAsStreamAsync | Save the workbook to a writable stream asynchronous. |
| SaveAsync | Saves the workbook asynchronous. |
| SetCurrentWorksheet(Int32) | Sets the current worksheet |
| SetCurrentWorksheet(String) | Sets the current worksheet |
| SetCurrentWorksheet(Worksheet) | Sets the current worksheet |
| SetImportState | Sets the import state. If an import is in progress, no validity checks on are performed to avoid conflicts by incomplete data (e.g. hidden worksheets) |
| SetSelectedWorksheet(Int32) | Sets the selected worksheet in the output workbook |
| SetSelectedWorksheet(String) | 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) |
| ValidateWorksheets |
Validates the worksheets regarding several conditions that must be met: - At least one worksheet must be defined - A hidden worksheet cannot be the selected one - At least one worksheet must be visible If one of the conditions is not met, an exception is thrown |
Fields| Name | Description | |
|---|---|---|
 | importInProgress |
See Also