ExcelWorkbook Class |
The Excel Workbook
Inheritance HierarchySystemObject
ExpertXls.ExcelLibExcelWorkbook
ExpertXls.ExcelLibExcelWorkbook
Namespace: ExpertXls.ExcelLib
Assembly: expertxls (in expertxls.dll) Version: 7.0.0
SyntaxThe ExcelWorkbook type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ExcelWorkbook |
Creates a workbook with a single worksheet. The default workbook format is Excel 2003.
To create a workbook for a different Excel format, like Excel 2007-2019 or above, you can use the constructor
with the Format parameter.
|
| ExcelWorkbook(Stream) |
Opens a workbook from the specified Excel stream
|
| ExcelWorkbook(String) |
Opens a workbook from the specified Excel file
|
| ExcelWorkbook(ExcelWorkbookFormat) |
Creates a workbook with a single worksheet. The format of the workbook is specified by the workbookFormat parameter.
The currently supported formats are Excel 97-2003 format and Excel 2007-2019 or above format.
|
| ExcelWorkbook(Stream, String) |
Opens a workbook from the specified Excel stream with the specified password
|
| ExcelWorkbook(String, String) |
Opens a workbook from the specified Excel file with the specified password
|
| ExcelWorkbook(ExcelWorkbookFormat, ExcelWorkbookDefaultSettings) |
Creates a workbook with a single worksheet. The format of the workbook is specified by the workbookFormat parameter.
The currently supported formats are Excel 97-2003 format and Excel 2007-2019 or above format.
|
| ExcelWorkbook(Stream, String, ExcelWorkbookDefaultSettings) |
Opens a workbook from the specified Excel stream with the specified password
|
| ExcelWorkbook(String, String, ExcelWorkbookDefaultSettings) |
Opens a workbook from the specified Excel file with the specified password
|
Properties| Name | Description | |
|---|---|---|
 | ActiveSheetIndex |
Gets or sets the active sheet index. The index is zero based. The property can be set with a non-negative value.
Returns a negative value when no sheet is active in the workbook.
|
| ChartWorksheets |
Gets the collection of chart worksheets of this workbook.
|
| DefaultColumnWidthChars |
Gets default column width in characters for the newly created worksheets.
|
| DefaultFontName |
Gets or sets default font name for the newly created worksheets.
|
| DefaultFontSizePoints |
Gets or sets default font size in points for the newly created worksheets.
|
| DefaultRowHeightPoints |
Gets the default row height in points for the newly created worksheets.
|
| DocumentProperties |
Gets the object encpsulating the document properties like author, title, subject, etc.
|
| DocumentSecurity |
Gets an object used to manage the document security like workbook structure and windows protection,
workbook open/write password protection. Works only for Excel 2003 .xls format.
|
| Format |
Gets or sets the Excel workbook format (Excel 97-2003 .xls or Excel 2007-2019 or above .xlsx). This property gives the output format
when the workbook is saved and controls the features allowed when the workbook is updated by the library.
When creating an empty workbook the format is Excel 97-2003. When the workbook is created
from an existing excel file or stream, the format is the format of the opened excel document.
|
| FormulaNumberFormat |
Gets or sets the number format in formula used when parsing formulas. Set this property before assigning
a formula expression to a cell. The default value is the number format for the current culture.
|
| FormulaParamsSeparator |
Gets or sets the separator between formula parameters used when parsing formulas. Set this property before assigning
a formula expression to a cell. The default value is ','.
|
| FormulaRowsSeparator |
Gets or sets the rows separator used when parsing arrays in formulas. Set this property before assigning
a formula expression to a cell. The default value is ';'
|
| LicenseKey |
Gets or sets the license key for the library.
When this property is set to null value the library works in demo mode.
|
| NamedRanges |
Gets the named ranges collection of this workbook (Workbook scope named ranges).
|
| Palette |
Gets the colors palette of the workbook.
|
| ReadOnly |
Gets a value that indicates whether the workbook has been opened as read-only
|
| Styles |
Gets the cell styles collection of this workbook.
|
| UnitsConverter |
Gets an object used to convert values between various Excel measurement units (points, pixels, width characters)
|
| Worksheets |
Gets the worksheets collection of this workbook.
|
Methods| Name | Description | |
|---|---|---|
| Close |
Closes the workbook and releases all the resources.
|
| DisableFormulaCalculations |
Disable formula calculations for all the sheets existing in the workbook at the current time.
|
| EnableFormulaCalculations |
Enable formula calculations for all the sheets existing in the workbook at the current time.
|
 | LoadFromCsv(Stream, String, ExcelWorkbookFormat) |
Loads a CSV stream into a worksheet. The default encoding of the text in CSV is assumed to be UTF-8.
The values from CSV will be imported in the top left corner of the worksheet.
|
| LoadFromCsv(String, String, ExcelWorkbookFormat) |
Loads a CSV file into a worksheet. The default encoding of the text in CSV is assumed to be UTF-8.
The values from CSV will be imported in the top left corner of the worksheet.
|
| LoadFromCsv(Stream, Encoding, String, Int32, Int32, ExcelWorkbookFormat, ExcelWorkbookDefaultSettings) |
Loads a CSV stream into a worksheet.
|
| LoadFromCsv(String, Encoding, String, Int32, Int32, ExcelWorkbookFormat, ExcelWorkbookDefaultSettings) |
Loads a CSV file into a worksheet.
|
| Save |
Saves the Excel workbook as byte array that can be further saved into a file or send over HTTP.
The output format (Excel 97-2003 .xls or Excel 2007-2019 or above .xlsx) is the current format of the workbook.
|
| Save(Stream) | A
Saves the workbook in the specified stream.
The output format (Excel 97-2003 .xls or Excel 2007-2019 or above .xlsx) is the current format of the workbook.
|
| Save(String) |
Saves the workbook as the specified file.
The output format (Excel 97-2003 .xls or Excel 2007-2019 or above .xlsx) is the current format of the workbook.
|
| Save(HttpResponse, String) |
Saves the workbook to the specified HttpResponse.
The output format (Excel 97-2003 .xls or Excel 2007-2019 or above .xlsx) is the current format of the workbook.
|
| Save(HttpResponse, String, Boolean) |
Saves the workbook to the specified HttpResponse.
The output format (Excel 97-2003 .xls or Excel 2007-2019 or above .xlsx) is the current format of the workbook.
|
| SaveToCsv(Int32, Stream, String) |
Saves the worksheet at the specified index to a stream in CSV format. The default UTF-8 text encoding is used when saving the output stream.
|
| SaveToCsv(Int32, String, String) |
Saves the worksheet at the specified index to a file in CSV format. The default UTF-8 text encoding is used when saving the output file.
|
| SaveToCsv(Int32, Stream, String, Encoding) |
Saves the worksheet at the specified index to a stream in CSV format using the specified text encoding for the output.
|
| SaveToCsv(Int32, String, String, Encoding) |
Saves the worksheet at the specified index to a file in CSV format using the specified text encoding for the output file.
|
| UpdateFormulaResult |
Calculate formula results for all the worksheets in the workbook
|
See Also