Free Trial
Web API version
Licensing
Request A Quote
HAVE QUESTIONS OR NEED HELP? SUBMIT THE SUPPORT REQUEST FORM or write email to SUPPORT@BYTESCOUT.COM
Main class for read and create XLS files
Inheritance Hierarchy
Bytescout.SpreadsheetSpreadsheet
Namespace: Bytescout.Spreadsheet
Assembly: Bytescout.Spreadsheet (in Bytescout.Spreadsheet.dll) Version: 4.7.1.2054-master
Syntax
The Spreadsheet type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Spreadsheet |
Initializes a new instance of the Spreadsheet class.
|
| Spreadsheet(String, String) |
Initializes a new instance of the Spreadsheet class.
|
Properties
| Name | Description | |
|---|---|---|
 | Cache |
Sets the cache type.
|
| CustomFunctionsCallback |
Gets or sets the callback external functions.
|
| LicenseInfo |
Gets license information.
|
| Options |
Gets the options.
|
| RegistrationKey | |
| RegistrationName | |
| SearchOptions |
Gets the search options.
|
| UserName |
Gets or sets the user name for document information.
|
| Version |
Gets the component version number.
|
| Workbook |
Gets or sets the Workbook.
|
| Worksheets |
Gets or sets the Worksheets.
|
Methods
| Name | Description | |
|---|---|---|
| Close |
Closes this instance.
|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| ExportTo2DArray |
Return spreadsheet rows and columns as two-dimensional array;
|
| ExportTo2DArray(Int32) |
Return spreadsheet rows and columns as two-dimensional array;
|
| ExportTo2DArray(String) |
Return spreadsheet rows and columns as two-dimensional array;
|
| ExportToDataSet |
Return new DataSet filled from spreadsheet.
|
| ExportToDataSet(DataSet) |
Fill provided DataSet with DataTables created from spreadsheet's worksheets.
|
| ExportToDataSet(DataSet, Boolean) |
Fill provided DataSet with DataTables created from spreadsheet's worksheets.
|
| ExportToDataTable |
Return new DataTable object filled from first worksheet.
|
| ExportToDataTable(Int32) |
Return new DataTable object filled from specified worksheet.
|
| ExportToDataTable(String) |
Return new DataTable object filled from specified worksheet.
|
| ExportToDataTable(Int32, Boolean) |
Return new DataTable object filled from specified worksheet.
if set to true use data from first row as columns header]. |
| ExportToDataTable(String, Boolean) |
Return new DataTable object filled from specified worksheet.
|
| ExportToJaggedArray |
Return spreadsheet rows and columns as jagged array
|
| ExportToJaggedArray(Int32) |
Return the cells in the specified worksheet as a jagged array
|
| ExportToJaggedArray(String) |
Return the cells in the named worksheet as a jagged array
|
| ExportToJSON |
Return JSON data filled from spreadsheet.
|
| ExportToList(IList) |
Export rows to provided IList. Each row is String[] array of column values.
|
| ExportToList(IList, Int32) |
Export the worksheet specified by index to the list
|
| ExportToList(IList, String) |
Export the named worksheet to the list
|
 | Finalize |
Releases unmanaged resources and performs other cleanup operations before the
Spreadsheet is reclaimed by garbage collection.
(Overrides ObjectFinalize.) |
| GetAsBytesArray |
Gets the bytes of spreadsheet saved as document with specified type.
|
| GetAsBytesArrayCSV |
Gets the bytes of spreadsheet saved as CSV document.
|
| GetAsBytesArrayHTML |
Gets the bytes of spreadsheet saved as HTML document.
|
| GetAsBytesArrayHTML(Int32) |
Gets the bytes of specified worksheet page saved as HTML document.
|
| GetAsBytesArrayTXT |
Gets the bytes of spreadsheet saved as text document.
|
| GetAsBytesArrayXLS |
Gets the bytes of spreadsheet saved as XLS document.
|
| GetAsBytesArrayXLSX |
Gets the bytes of spreadsheet saved as XLSX document.
|
| GetAsBytesArrayXML |
Gets the bytes of spreadsheet saved as XML document.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the type of the current instance. (Inherited from Object.) |
| ImportFrom2DArray(String) |
Import from two-dimensional array.
|
| ImportFrom2DArray(String, Int32) |
Import from two-dimensional array to the specified worksheet
|
| ImportFrom2DArray(String, String) |
Import from two-dimensional array to the specified worksheet
|
| ImportFromDataSet(DataSet) |
Fills the spreadsheet with rows and columns from tables of specified DataSet.
|
| ImportFromDataSet(DataSet, UInt32) |
Fills the spreadsheet with rows and columns from tables of specified DataSet. The method will automatically create new worksheet if table row count exceeds specified row limit.
|
| ImportFromDataTable(DataTable) |
Fills the spreadsheet with rows and columns from specified DataTable.
|
| ImportFromDataTable(DataTable, Int32) |
Import rows and columns from DataTable to specified worksheet.
|
| ImportFromDataTable(DataTable, String) |
Import rows and columns from DataTable to specified worksheet.
|
| ImportFromDataTable(DataTable, UInt32) |
Fills the spreadsheet with rows and columns from specified DataTable. The method will automatically create new worksheet if table row count exceeds specified row limit.
|
| ImportFromJaggedArray(String) |
Import from jagged array.
|
| ImportFromJaggedArray(String, Int32) |
Import from jagged array to the specified worksheet
|
| ImportFromJaggedArray(String, String) |
Import from jagged array to the specified worksheet
|
| ImportFromJSON |
Fills the spreadsheet with rows and columns from JSON data string.
|
| ImportFromList(IList) |
Import from IList of rows. Each row will contain IList of columns.
|
| ImportFromList(IList, Int32) |
Import from IList of rows to the specified worksheet
|
| ImportFromList(IList, String) |
Import from IList of rows to the specified worksheet
|
| LoadFromFile(String) |
Load data from file.
|
| LoadFromFile(String, CacheType) |
Load data from file.
|
| LoadFromFile(String, String) |
Load data from file.
|
| LoadFromFile(String, CacheType, String) |
Load data from file.
|
| LoadFromFile(String, String, Encoding) |
Load data from file.
|
| LoadFromFile(String, CacheType, String, Encoding) |
Load data from file.
|
| LoadFromFile(String, CacheType, String, Encoding, String) |
Load data from file.
|
| LoadFromStream(Stream) |
Load data from stream.
|
| LoadFromStream(Stream, CacheType) |
Load data from stream.
|
| LoadFromStream(Stream, SpreadsheetFormatType) |
Load data from stream.
|
| LoadFromStream(Stream, CacheType, String) |
Load data from stream.
|
| LoadFromStream(Stream, SpreadsheetFormatType, CacheType) |
Load data from stream.
|
| LoadFromStream(Stream, SpreadsheetFormatType, String, Encoding) |
Load data from stream.
|
| LoadFromStream(Stream, SpreadsheetFormatType, CacheType, String, Encoding) |
Load data from stream.
|
| LoadFromStream(Stream, SpreadsheetFormatType, CacheType, String, Encoding, String) |
Load data from stream.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SaveAs(String) |
Saves data in XLS or XLSX file FileName.
|
| SaveAs(String, SpreadsheetFormatType) |
Saves data in XLS or XLSX file FileName.
|
| SaveAsCSV(String, Int32) |
Saves data in CSV file with specified name.
|
| SaveAsCSV(String, Int32, String) |
Saves data in CSV file with specified name.
|
| SaveAsCSV(String, Int32, String, String) |
Saves data in CSV file with specified name.
|
| SaveAsCSV(String, Int32, String, String, Encoding) |
Saves data in CSV file with specified name.
|
| SaveAsCSV(String, Int32, String, String, Encoding, Boolean) |
Saves data in CSV file with specified name.
|
| SaveAsHTML(String) |
Saves spreadsheet in a HTML format file.
The second and subsequent worksheets of the spreadsheet will be saved
in separate files with auto-generated names.
|
| SaveAsHTML(String, Boolean) |
Saves spreadsheet in a HTML format file.
The second and subsequent worksheets of the spreadsheet will be saved
in separate files with auto-generated names.
|
| SaveAsPDF(Stream) |
Exports spreadsheet to stream in PDF format.
|
| SaveAsPDF(String) |
Saves spreadsheet to PDF file with specified name.
|
| SaveAsPDF(Stream, Boolean) |
Exports spreadsheet to stream in PDF format.
|
| SaveAsPDF(String, Boolean) |
Saves spreadsheet to PDF file with specified name.
|
| SaveAsPDF(Stream, Boolean, String) |
Exports spreadsheet to stream in PDF format.
|
| SaveAsPDF(String, Boolean, String) |
Saves spreadsheet to PDF file with specified name.
|
| SaveAsTXT(String, Int32) |
Saves data in TXT delimiter-separated file with specified name.
|
| SaveAsTXT(String, Int32, String) |
Saves data in TXT delimiter-separated file with specified name.
|
| SaveAsTXT(String, Int32, String, String) |
Saves data in TXT delimiter-separated file with specified name.
|
| SaveAsTXT(String, Int32, String, String, Encoding) |
Saves data in TXT delimiter-separated file with specified name.
|
| SaveAsTXT(String, Int32, String, String, Encoding, Boolean) |
Saves data in TXT delimiter-separated file with specified name.
|
| SaveAsXLS |
Saves data in XLS file with specified name.
|
| SaveAsXLSX(String) |
Saves data in XLSX format to a file with specified name.
|
| SaveAsXLSX(String, String) |
Saves data in XLSX format to a file with specified name.
|
| SaveAsXML(String, Int32) |
Saves data in XML file with specified name.
|
| SaveAsXML(String, Int32, Encoding) |
Saves data in XML file with specified name.
|
| SaveToStream(Stream) |
Saves data in XLS format to a given stream.
|
| SaveToStream(Stream, SpreadsheetFormatType) |
Saves data in XLS or XLSX format to a given stream.
|
| SaveToStreamCSV(Stream, Int32) |
Saves data in CSV format to a given stream.
|
| SaveToStreamCSV(Stream, Int32, String) |
Saves data in CSV format to a given stream.
|
| SaveToStreamCSV(Stream, Int32, String, String) |
Saves data in CSV format to a given stream.
|
| SaveToStreamCSV(Stream, Int32, String, String, Encoding) |
Saves data in CSV format to a given stream.
|
| SaveToStreamCSV(Stream, Int32, String, String, Encoding, Boolean) |
Saves data in CSV format to a given stream.
|
| SaveToStreamHTML(Stream) |
Saves first worksheet of spreadsheet as HTML document to a given stream.
|
| SaveToStreamHTML(Stream, Int32) |
Saves a worksheet of spreadsheet as HTML document to a given stream.
|
| SaveToStreamTXT(Stream, Int32) |
Saves data in TXT format to a given stream.
|
| SaveToStreamTXT(Stream, Int32, String) |
Saves data in TXT format to a given stream.
|
| SaveToStreamTXT(Stream, Int32, String, String) |
Saves data in TXT format to a given stream.
|
| SaveToStreamTXT(Stream, Int32, String, String, Encoding) |
Saves data in TXT format to a given stream.
|
| SaveToStreamTXT(Stream, Int32, String, String, Encoding, Boolean) |
Saves data in TXT format to a given stream.
|
| SaveToStreamXLS |
Saves data in XLS format to a given stream.
|
| SaveToStreamXLSX(Stream) |
Saves data in XLSX format to a given stream.
|
| SaveToStreamXLSX(Stream, String) |
Saves data in XLSX format to a given stream.
|
| SaveToStreamXML(Stream, Int32) |
Saves data in XML format to a given stream.
|
| SaveToStreamXML(Stream, Int32, Encoding) |
Saves data in XML format to a given stream.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Worksheet |
Return Worksheet the specified index.
|
Events
| Name | Description | |
|---|---|---|
  | OnCalcError |
Occurs when [on calc error].
|
Fields
| Name | Description | |
|---|---|---|
 | LoadProgress |
CallBack function to fire on file loading progress tracking.
|
See Also