API Reference
ExcelDocumentReader
Reader for an Excel workbook (read-only). Provides access to sheet readers and basic metadata.
Inheritance
- Object
- ExcelDocumentReader
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method ExcelDocument.CreateReader
- Method ExcelDocumentReader.Open
- Method ExcelDocumentReader.Open
- Method ExcelDocumentReader.OpenAsync
- Method ExcelDocumentReader.Wrap
Accepted by parameters
- Extension method ExcelDocumentReader.ExtractChunks
- Method ExcelExtractionExtensions.ExtractChunks
Methods
public ExcelSheetReader GetSheet(String name) #ExcelSheetReaderGets a reader for the specified worksheet name.
Parameters
- name System.String
public ExcelSheetReader GetSheet(Int32 index) #ExcelSheetReaderGets a reader by sheet index (1-based, Excel display order).
Parameters
- index System.Int32
public IReadOnlyList<String> GetSheetNames() #IReadOnlyList<String>Returns the list of sheet names in workbook order.
public ExcelTableInfo GetTable(String tableName) #ExcelTableInfoGets metadata for a table by name or display name.
Parameters
- tableName System.String
public IReadOnlyList<ExcelTableInfo> GetTables() #IReadOnlyList<ExcelTableInfo>Returns all Excel tables defined in the workbook.
public static ExcelDocumentReader Open(Byte[] bytes, ExcelReadOptions options = null) #ExcelDocumentReaderOpens an Excel file for read-only access.
Parameters
- path System.String
- options OfficeIMO.Excel.ExcelReadOptions = null
Open(System.IO.Stream stream, OfficeIMO.Excel.ExcelReadOptions options) #Opens an Excel workbook from the provided stream for read-only access.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Excel.ExcelReadOptions
Open(System.Byte[] bytes, OfficeIMO.Excel.ExcelReadOptions options) #Opens an Excel workbook from an in-memory package for read-only access. The byte array is used directly; callers should not modify it while the reader is alive.
Parameters
- bytes System.Byte[]
- options OfficeIMO.Excel.ExcelReadOptions
public static ExcelDocumentReader Open(Uri uri, ExcelReadOptions options = null, ExcelHttpLoadOptions httpOptions = null) #ExcelDocumentReaderOpens a remote Excel workbook for read-only access.
Parameters
- uri System.Uri
- HTTP or HTTPS URI of the workbook.
- options OfficeIMO.Excel.ExcelReadOptions = null
- Optional read options.
- httpOptions OfficeIMO.Excel.ExcelHttpLoadOptions = null
- Optional HTTP loading options.
Returns
Workbook reader.
public static async Task<ExcelDocumentReader> OpenAsync(Uri uri, ExcelReadOptions options = null, ExcelHttpLoadOptions httpOptions = null, CancellationToken cancellationToken = null) #Task<ExcelDocumentReader>Asynchronously opens a remote Excel workbook for read-only access.
Parameters
- uri System.Uri
- HTTP or HTTPS URI of the workbook.
- options OfficeIMO.Excel.ExcelReadOptions = null
- Optional read options.
- httpOptions OfficeIMO.Excel.ExcelHttpLoadOptions = null
- Optional HTTP loading options.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.
Returns
Workbook reader.
public Object[] ReadTable(String tableName) #Object[]Reads an Excel table by name into a dense matrix.
Parameters
- tableName System.String
public DataTable ReadTableAsDataTable(String tableName, Nullable<Boolean> headersInFirstRow = null, Nullable<ExecutionMode> mode = null, CancellationToken ct = null) #DataTableReads an Excel table by name into a DataTable.
Parameters
- tableName System.String
- headersInFirstRow System.Nullable{System.Boolean} = null
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null
- ct System.Threading.CancellationToken = null
public IEnumerable<T> ReadTableObjects<T>(String tableName, Nullable<ExecutionMode> mode = null, CancellationToken ct = null) #IEnumerable<T>Reads an Excel table by name as dictionaries using the table header row.
Type Parameters
- T
Parameters
- tableName System.String
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null
- ct System.Threading.CancellationToken = null
public IEnumerable<T> ReadTableObjectsStream<T>(String tableName, CancellationToken ct = null) #IEnumerable<T>Type Parameters
- T
Parameters
- tableName String
- ct CancellationToken = null
ReadTableObjectsStream``1(System.String tableName, System.Threading.CancellationToken ct) #Streams an Excel table by name and maps rows to objects using the table header row.
Parameters
- tableName System.String
- ct System.Threading.CancellationToken
ReadTableObjects``1(System.String tableName, System.Nullable{OfficeIMO.Excel.ExecutionMode} mode, System.Threading.CancellationToken ct) #Reads an Excel table by name and maps rows to objects using the table header row.
Parameters
- tableName System.String
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode}
- ct System.Threading.CancellationToken
public static ExcelDocumentReader Wrap(SpreadsheetDocument document, ExcelReadOptions options = null) #ExcelDocumentReaderWraps an already open SpreadsheetDocument without taking ownership. The returned reader must be disposed, but it will not close the underlying document.
Parameters
- document DocumentFormat.OpenXml.Packaging.SpreadsheetDocument
- options OfficeIMO.Excel.ExcelReadOptions = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Int32 SheetCount { get; } #The number of worksheets in the workbook.
Extension Methods
public static IEnumerable<ExcelExtractChunk> ExtractChunks(ExcelDocumentReader reader, String sheetName, String a1Range = null, ExcelExtractOptions extract = null, ExcelExtractChunkingOptions chunking = null, String sourcePath = null, CancellationToken cancellationToken = null) #IEnumerable<ExcelExtractChunk>Extracts an Excel sheet range into row-chunked ExcelExtractChunk instances.
Parameters
- reader OfficeIMO.Excel.ExcelDocumentReader
- Workbook reader.
- sheetName System.String
- Sheet to extract.
- a1Range System.String = null
- A1 range; when null, uses the sheet's used range.
- extract OfficeIMO.Excel.ExcelExtractionExtensions.ExcelExtractOptions = null
- Extraction options.
- chunking OfficeIMO.Excel.ExcelExtractChunkingOptions = null
- Chunking options.
- sourcePath System.String = null
- Optional source path for citations.
- cancellationToken System.Threading.CancellationToken = null
- Cancellation token.