API Reference
ExcelSheetReader
Column-oriented readers for ExcelSheetReader.
Inheritance
- Object
- ExcelSheetReader
Methods
public IEnumerable<CellValueInfo> EnumerateCells() #IEnumerable<CellValueInfo>Enumerates non-empty cells as (Row, Column, Value). Values are typed when possible.
public IEnumerable<CellValueInfo> EnumerateRange(String a1Range) #IEnumerable<CellValueInfo>Enumerates non-empty cells within the given A1 range as typed values.
Parameters
- a1Range System.String
public String GetUsedRangeA1() #StringReturns the used range of the worksheet as an A1 string (e.g., "A1:C10"). If the sheet is empty, returns "A1:A1".
public IEnumerable<Object> ReadColumn(String a1Range, CancellationToken ct = null) #IEnumerable<Object>Reads a single-column A1 range (e.g., "B2:B1000") as a typed sequence.
Parameters
- a1Range System.String
- ct System.Threading.CancellationToken = null
public IEnumerable<T> ReadColumnAs<T>(String a1Range, Func<Object, T> convert = null, CancellationToken ct = null) #IEnumerable<T>Type Parameters
- T
Parameters
- a1Range String
- convert Func<Object, T> = null
- ct CancellationToken = null
ReadColumnAs``1(System.String a1Range, System.Func{System.Object,``0} convert, System.Threading.CancellationToken ct) #Reads a single-column A1 range as a typed sequence.
Type Parameters
- T
- Target element type.
Parameters
- a1Range System.String
- Single-column A1 range (e.g., "B2:B100").
- convert System.Func{System.Object,``0}
- Optional custom converter. If null, uses culture-aware conversion.
- ct System.Threading.CancellationToken
- Cancellation token.
public IEnumerable<Dictionary<String, Object>> ReadObjects(String a1Range, Nullable<ExecutionMode> mode = null, CancellationToken ct = null) #IEnumerable<Dictionary<String, Object>>Reads a rectangular range into a sequence of dictionaries using the first row as headers.
Type Parameters
- T
Parameters
- a1Range System.String
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null
- ct System.Threading.CancellationToken = null
ReadObjects``1(System.String a1Range, System.Nullable{OfficeIMO.Excel.ExecutionMode} mode, System.Threading.CancellationToken ct) #Reads a rectangular range and maps rows (excluding the header row) into instances of T. Header cells are matched to public writable properties on T by name (case-insensitive).
Parameters
- a1Range System.String
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode}
- ct System.Threading.CancellationToken
public Object[] ReadRange(String a1Range, Nullable<ExecutionMode> mode = null, CancellationToken ct = null) #Object[]Reads a rectangular A1 range (e.g., "A1:C10") into a dense 2D array of typed values.
Parameters
- a1Range System.String
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null
- ct System.Threading.CancellationToken = null
public T[] ReadRangeAs<T>(String a1Range, Nullable<ExecutionMode> mode = null, CancellationToken ct = null) #T[]Type Parameters
- T
Parameters
- a1Range String
- mode Nullable<ExecutionMode> = null
- ct CancellationToken = null
public DataTable ReadRangeAsDataTable(String a1Range, Boolean headersInFirstRow = true, Nullable<ExecutionMode> mode = null, CancellationToken ct = null) #DataTableReads a rectangular range to a DataTable. If headersInFirstRow = true, first row becomes column names.
Parameters
- a1Range System.String
- headersInFirstRow System.Boolean = true
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null
- ct System.Threading.CancellationToken = null
ReadRangeAs``1(System.String a1Range, System.Nullable{OfficeIMO.Excel.ExecutionMode} mode, System.Threading.CancellationToken ct) #Reads a rectangular range into a dense typed matrix.
Type Parameters
- T
- Target element type for each cell.
Parameters
- a1Range System.String
- Inclusive A1 range (e.g., "A1:C10").
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode}
- Execution override (affects conversion only).
- ct System.Threading.CancellationToken
- Cancellation token.
public IEnumerable<RangeChunk> ReadRangeStream(String a1Range, Int32 chunkRows = 1024, Nullable<ExecutionMode> mode = null, CancellationToken ct = null) #IEnumerable<RangeChunk>Lazily reads a rectangular A1 range as ordered row chunks. DOM traversal is single-threaded; per-chunk value conversion is offloaded in parallel based on Execution policy.
Parameters
- a1Range System.String
- chunkRows System.Int32 = 1024
- mode System.Nullable{OfficeIMO.Excel.ExecutionMode} = null
- ct System.Threading.CancellationToken = null
public IEnumerable<Object[]> ReadRows(String a1Range, CancellationToken ct = null) #IEnumerable<Object[]>Lazily reads each row within the A1 range as a typed object array. Values are converted using shared strings and styles (date detection).
Parameters
- a1Range System.String
- Inclusive A1 range (e.g., "A1:C100").
- ct System.Threading.CancellationToken = null
- Cancellation token.
Returns
Sequence of rows as object?[] with fixed width equal to the range width. Rows without any cells yield null.
public IEnumerable<T[]> ReadRowsAs<T>(String a1Range, Func<Object, T> convert = null, CancellationToken ct = null) #IEnumerable<T[]>Type Parameters
- T
Parameters
- a1Range String
- convert Func<Object, T> = null
- ct CancellationToken = null
ReadRowsAs``1(System.String a1Range, System.Func{System.Object,``0} convert, System.Threading.CancellationToken ct) #Streams each row within the A1 range as a typed array.
Type Parameters
- T
- Target element type for each cell.
Parameters
- a1Range System.String
- Inclusive A1 range (e.g., "A1:C100").
- convert System.Func{System.Object,``0}
- Optional custom converter. If null, uses culture-aware conversion.
- ct System.Threading.CancellationToken
- Cancellation token.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object