Link Search Menu Expand Document

Spreadsheet Class

Main class for read and create XLS files
Inheritance Hierarchy
SystemObject
Bytescout.SpreadsheetSpreadsheet

Namespace:Bytescout.Spreadsheet
Assembly: Bytescout.Spreadsheet (in Bytescout.Spreadsheet.dll) Version: 4.5.1.2018-master
Syntax
public class Spreadsheet : IDisposable, 
	ISpreadsheet

The Spreadsheet type exposes the following members.

Constructors
NameDescription
Public methodSpreadsheet
Initializes a new instance of the Spreadsheet class.
Public methodSpreadsheet(String, String)
Initializes a new instance of the Spreadsheet class.
Top
Properties
NameDescription
Public propertyCache
Sets the cache type.
Public propertyCustomFunctionsCallback
Gets or sets the callback external functions.
Public propertyLicenseInfo
Gets license information.
Public propertyOptions
Gets the options.
Public propertyRegistrationKey
Public propertyRegistrationName
Public propertySearchOptions
Gets the search options.
Public propertyUserName
Gets or sets the user name for document information.
Public propertyVersion
Gets the component version number.
Public propertyWorkbook
Gets or sets the Workbook.
Public propertyWorksheets
Gets or sets the Worksheets.
Top
Methods
NameDescription
Public methodClose
Closes this instance.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExportTo2DArray
Return spreadsheet rows and columns as two-dimensional array;
Public methodExportTo2DArray(Int32)
Return spreadsheet rows and columns as two-dimensional array;
Public methodExportTo2DArray(String)
Return spreadsheet rows and columns as two-dimensional array;
Public methodExportToDataSet
Return new DataSet filled from spreadsheet.
Public methodExportToDataSet(DataSet)
Fill provided DataSet with DataTables created from spreadsheet's worksheets.
Public methodExportToDataSet(DataSet, Boolean)
Fill provided DataSet with DataTables created from spreadsheet's worksheets.
Public methodExportToDataTable
Return new DataTable object filled from first worksheet.
Public methodExportToDataTable(Int32)
Return new DataTable object filled from specified worksheet.
Public methodExportToDataTable(String)
Return new DataTable object filled from specified worksheet.
Public methodExportToDataTable(Int32, Boolean)
Return new DataTable object filled from specified worksheet. if set to true use data from first row as columns header].
Public methodExportToDataTable(String, Boolean)
Return new DataTable object filled from specified worksheet.
Public methodExportToJaggedArray
Return spreadsheet rows and columns as jagged array
Public methodExportToJaggedArray(Int32)
Return the cells in the specified worksheet as a jagged array
Public methodExportToJaggedArray(String)
Return the cells in the named worksheet as a jagged array
Public methodExportToJSON
Return JSON data filled from spreadsheet.
Public methodExportToList(IList)
Export rows to provided IList. Each row is String[] array of column values.
Public methodExportToList(IList, Int32)
Export the worksheet specified by index to the list
Public methodExportToList(IList, String)
Export the named worksheet to the list
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before theSpreadsheet is reclaimed by garbage collection.
(Overrides ObjectFinalize.)
Public methodGetAsBytesArray
Gets the bytes of spreadsheet saved as document with specified type.
Public methodGetAsBytesArrayCSV
Gets the bytes of spreadsheet saved as CSV document.
Public methodGetAsBytesArrayHTML
Gets the bytes of spreadsheet saved as HTML document.
Public methodGetAsBytesArrayHTML(Int32)
Gets the bytes of specified worksheet page saved as HTML document.
Public methodGetAsBytesArrayTXT
Gets the bytes of spreadsheet saved as text document.
Public methodGetAsBytesArrayXLS
Gets the bytes of spreadsheet saved as XLS document.
Public methodGetAsBytesArrayXLSX
Gets the bytes of spreadsheet saved as XLSX document.
Public methodGetAsBytesArrayXML
Gets the bytes of spreadsheet saved as XML document.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodImportFrom2DArray(String)
Import from two-dimensional array.
Public methodImportFrom2DArray(String, Int32)
Import from two-dimensional array to the specified worksheet
Public methodImportFrom2DArray(String, String)
Import from two-dimensional array to the specified worksheet
Public methodImportFromDataSet(DataSet)
Fills the spreadsheet with rows and columns from tables of specified DataSet.
Public methodImportFromDataSet(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.
Public methodImportFromDataTable(DataTable)
Fills the spreadsheet with rows and columns from specified DataTable.
Public methodImportFromDataTable(DataTable, Int32)
Import rows and columns from DataTable to specified worksheet.
Public methodImportFromDataTable(DataTable, String)
Import rows and columns from DataTable to specified worksheet.
Public methodImportFromDataTable(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.
Public methodImportFromJaggedArray(String)
Import from jagged array.
Public methodImportFromJaggedArray(String, Int32)
Import from jagged array to the specified worksheet
Public methodImportFromJaggedArray(String, String)
Import from jagged array to the specified worksheet
Public methodImportFromJSON
Fills the spreadsheet with rows and columns from JSON data string.
Public methodImportFromList(IList)
Import from IList of rows. Each row will contain IList of columns.
Public methodImportFromList(IList, Int32)
Import from IList of rows to the specified worksheet
Public methodImportFromList(IList, String)
Import from IList of rows to the specified worksheet
Public methodLoadFromFile(String)
Load data from file.
Public methodLoadFromFile(String, CacheType)
Load data from file.
Public methodLoadFromFile(String, String)
Load data from file.
Public methodLoadFromFile(String, CacheType, String)
Load data from file.
Public methodLoadFromFile(String, String, Encoding)
Load data from file.
Public methodLoadFromFile(String, CacheType, String, Encoding)
Load data from file.
Public methodLoadFromFile(String, CacheType, String, Encoding, String)
Load data from file.
Public methodLoadFromStream(Stream)
Load data from stream.
Public methodLoadFromStream(Stream, CacheType)
Load data from stream.
Public methodLoadFromStream(Stream, SpreadsheetFormatType)
Load data from stream.
Public methodLoadFromStream(Stream, CacheType, String)
Load data from stream.
Public methodLoadFromStream(Stream, SpreadsheetFormatType, CacheType)
Load data from stream.
Public methodLoadFromStream(Stream, SpreadsheetFormatType, String, Encoding)
Load data from stream.
Public methodLoadFromStream(Stream, SpreadsheetFormatType, CacheType, String, Encoding)
Load data from stream.
Public methodLoadFromStream(Stream, SpreadsheetFormatType, CacheType, String, Encoding, String)
Load data from stream.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSaveAs(String)
Saves data in XLS or XLSX file FileName.
Public methodSaveAs(String, SpreadsheetFormatType)
Saves data in XLS or XLSX file FileName.
Public methodSaveAsCSV(String, Int32)
Saves data in CSV file with specified name.
Public methodSaveAsCSV(String, Int32, String)
Saves data in CSV file with specified name.
Public methodSaveAsCSV(String, Int32, String, String)
Saves data in CSV file with specified name.
Public methodSaveAsCSV(String, Int32, String, String, Encoding)
Saves data in CSV file with specified name.
Public methodSaveAsCSV(String, Int32, String, String, Encoding, Boolean)
Saves data in CSV file with specified name.
Public methodSaveAsHTML(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.
Public methodSaveAsHTML(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.
Public methodSaveAsPDF(Stream)
Exports spreadsheet to stream in PDF format.
Public methodSaveAsPDF(String)
Saves spreadsheet to PDF file with specified name.
Public methodSaveAsPDF(Stream, Boolean)
Exports spreadsheet to stream in PDF format.
Public methodSaveAsPDF(String, Boolean)
Saves spreadsheet to PDF file with specified name.
Public methodSaveAsPDF(Stream, Boolean, String)
Exports spreadsheet to stream in PDF format.
Public methodSaveAsPDF(String, Boolean, String)
Saves spreadsheet to PDF file with specified name.
Public methodSaveAsTXT(String, Int32)
Saves data in TXT delimiter-separated file with specified name.
Public methodSaveAsTXT(String, Int32, String)
Saves data in TXT delimiter-separated file with specified name.
Public methodSaveAsTXT(String, Int32, String, String)
Saves data in TXT delimiter-separated file with specified name.
Public methodSaveAsTXT(String, Int32, String, String, Encoding)
Saves data in TXT delimiter-separated file with specified name.
Public methodSaveAsTXT(String, Int32, String, String, Encoding, Boolean)
Saves data in TXT delimiter-separated file with specified name.
Public methodSaveAsXLS
Saves data in XLS file with specified name.
Public methodSaveAsXLSX(String)
Saves data in XLSX format to a file with specified name.
Public methodSaveAsXLSX(String, String)
Saves data in XLSX format to a file with specified name.
Public methodSaveAsXML(String, Int32)
Saves data in XML file with specified name.
Public methodSaveAsXML(String, Int32, Encoding)
Saves data in XML file with specified name.
Public methodSaveToStream(Stream)
Saves data in XLS format to a given stream.
Public methodSaveToStream(Stream, SpreadsheetFormatType)
Saves data in XLS or XLSX format to a given stream.
Public methodSaveToStreamCSV(Stream, Int32)
Saves data in CSV format to a given stream.
Public methodSaveToStreamCSV(Stream, Int32, String)
Saves data in CSV format to a given stream.
Public methodSaveToStreamCSV(Stream, Int32, String, String)
Saves data in CSV format to a given stream.
Public methodSaveToStreamCSV(Stream, Int32, String, String, Encoding)
Saves data in CSV format to a given stream.
Public methodSaveToStreamCSV(Stream, Int32, String, String, Encoding, Boolean)
Saves data in CSV format to a given stream.
Public methodSaveToStreamHTML(Stream)
Saves first worksheet of spreadsheet as HTML document to a given stream.
Public methodSaveToStreamHTML(Stream, Int32)
Saves a worksheet of spreadsheet as HTML document to a given stream.
Public methodSaveToStreamTXT(Stream, Int32)
Saves data in TXT format to a given stream.
Public methodSaveToStreamTXT(Stream, Int32, String)
Saves data in TXT format to a given stream.
Public methodSaveToStreamTXT(Stream, Int32, String, String)
Saves data in TXT format to a given stream.
Public methodSaveToStreamTXT(Stream, Int32, String, String, Encoding)
Saves data in TXT format to a given stream.
Public methodSaveToStreamTXT(Stream, Int32, String, String, Encoding, Boolean)
Saves data in TXT format to a given stream.
Public methodSaveToStreamXLS
Saves data in XLS format to a given stream.
Public methodSaveToStreamXLSX(Stream)
Saves data in XLSX format to a given stream.
Public methodSaveToStreamXLSX(Stream, String)
Saves data in XLSX format to a given stream.
Public methodSaveToStreamXML(Stream, Int32)
Saves data in XML format to a given stream.
Public methodSaveToStreamXML(Stream, Int32, Encoding)
Saves data in XML format to a given stream.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWorksheet
Return Worksheet the specified index.
Top
Events
NameDescription
Public eventStatic memberOnCalcError
Occurs when [on calc error].
Top
Fields
NameDescription
Public fieldLoadProgress
CallBack function to fire on file loading progress tracking.
Top
See Also

Reference


Copyright © 2016 - 2021 ByteScout