API Reference
ExcelReadOptions
Reading options controlling conversion behavior and execution policy.
Inheritance
- Object
- ExcelReadOptions
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 ExcelReadPresets.Aggressive
- Method ExcelReadPresets.DecimalFirst
- Method ExcelReadPresets.None
- Method ExcelReadPresets.Simple
Accepted by parameters
- Method ExcelDocument.CreateDataReader
- Method ExcelDocument.CreateInspectionSnapshot
- Method ExcelDocument.OpenDataReader
- Method ExcelDocument.OpenDataReader
- Method ExcelDocument.OpenDataReader
- Method ExcelDocument.OpenDataReaderAsync
- Method ExcelReadPresets.ApplyBasicConverters
- Method ExcelSheet.ApplyColumnFormatPlan
- Method ExcelSheet.ColumnStyleByHeader
- Method ExcelSheet.CreateDataReader
- Method ExcelSheet.EnumerateCells
- Method ExcelSheet.EnumerateRange
- Method ExcelSheet.GetHeaderMap
- Method ExcelSheet.RefreshHeaderCache
- Method ExcelSheet.RowsAsParallel``1
- Method ExcelSheet.RowsAsParallel``1
- Method ExcelSheet.RowsAsParallel``1
- Method ExcelSheet.RowsAsParallel``1
- Method ExcelSheet.RowsAsParallel``1
- Method ExcelSheet.RowsAsParallel``1
- Method ExcelSheet.RowsAs``1
- Method ExcelSheet.RowsAs``1
- Method ExcelSheet.RowsAs``1
- Method ExcelSheet.RowsAs``1
- Method ExcelSheet.RowsAs``1
- Method ExcelSheet.RowsAs``1
- Method ExcelSheet.SetByHeader
- Method ExcelSheet.TableToDataTable
- Method ExcelSheet.TableToJson
- Method ExcelSheet.ToDataTable
- Method ExcelSheet.ToDataTable
- Method ExcelSheet.ToJson
- Method ExcelSheet.ToJson
- Method ExcelSheet.TryGetColumnIndexByHeader
- Method ExcelSheet.TryGetColumnStyleByHeader
Constructors
public ExcelReadOptions() #Initializes reading defaults and per-operation thresholds.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String SheetName { get; set; } #Gets or sets the worksheet exposed by ExcelReadOptions). When omitted, worksheets are exposed in workbook order through NextResult.
public Nullable<Int32> SheetIndex { get; set; } #Gets or sets the zero-based worksheet index exposed by an Excel data reader. Cannot be combined with SheetName.
public String A1Range { get; set; } #Gets or sets an optional A1 range exposed from each selected worksheet. When omitted, the worksheet used range is exposed.
public Boolean HasHeaderRow { get; set; } #Gets or sets whether the first row supplies column names.
public Boolean InferSchema { get; set; } #Gets or sets whether the data-reader schema is inferred from worksheet values. Native cell values are preserved regardless of this setting.
public Int32 SchemaSampleRows { get; set; } #Gets or sets the maximum rows sampled when schema inference is enabled.
public Int64 MaxInputBytes { get; set; } #Maximum workbook bytes buffered by the Excel reader APIs. Default: 512 MiB.
public Int32 MaxDataReaderColumns { get; set; } #Maximum columns exposed by one range data reader.
public Int32 MaxDataReaderChunkRows { get; set; } #Maximum worksheet rows materialized in one data-reader chunk.
public Int32 MaxDataReaderSchemaSampleRows { get; set; } #Maximum rows retained for data-reader schema inference.
public Int64 MaxDataReaderBufferedCells { get; set; } #Maximum cells materialized by a data-reader chunk or schema sample.
public Int32 MaxXlsbCells { get; set; } #Maximum populated cell records accepted across one XLSB workbook. Default: 4,000,000. This is an aggregate safety limit, independent of per-chunk data-reader buffering.
public Int32 MaxXlsbLogicalRows { get; set; } #Maximum logical rows emitted across one XLSB workbook data-reader operation. Default: 1,048,576. Sparse row gaps consume this aggregate budget just like populated rows.
public Int64 MaxRangeCells { get; set; } #Maximum cells materialized by one dense range read. Default: 1,000,000.
public Int32 MaxPendingTypedRows { get; set; } #Maximum out-of-order rows retained by one typed streaming read. Default: 8,192.
public ExcelExecutionPolicy Execution { get; } #Execution policy used to decide Sequential vs Parallel conversion. Reuses the writer-side policy for symmetry.
public Boolean UseCachedFormulaResult { get; set; } #Use cached formula results when present; otherwise returns the formula string.
public Boolean TreatDatesUsingNumberFormat { get; set; } #Interpret numeric cells with a date-like number format as DateTime (OADate).
public CultureInfo Culture { get; set; } #Culture used when parsing numbers and dates stored as strings.
public CancellationToken CancellationToken { get; set; } #Cancellation observed while opening and streaming workbook data.
public Boolean FillBlanksInRanges { get; set; } #When true, matrix/range readers fill unspecified cells with nulls.
public Boolean NormalizeHeaders { get; set; } #Normalize headers for object mapping by trimming and collapsing whitespace.
public Boolean NumericAsDecimal { get; set; } #When true, numeric cells are returned as decimal where possible; otherwise double is used.
public Boolean InferDataTableColumnTypes { get; set; } #When true, DataTable reads infer stable column types from the materialized range. Mixed-type columns stay object-typed.
public Boolean StrictTypedMapping { get; set; } #When true, typed object readers throw if selected headers cannot be mapped deterministically to writable properties.
public Func<ExcelCellContext, ExcelCellValue> CellValueConverter { get; set; } #Optional cell-level converter hook. If provided and it returns a handled value, the built-in conversion pipeline is skipped and the returned value is used.
public Func<Object, Type, CultureInfo, ValueTuple<Boolean, Object>> TypeConverter { get; set; } #Optional type conversion hook used by typed readers (ReadColumnAs/ReadRowsAs/ReadRangeAs and object mapping). If it returns ok=true, its value is used; otherwise the built-in converter is used.
public DataMappingErrorValuePolicy MappingErrorValuePolicy { get; set; } #Gets or sets whether typed mapping failures may include source values. Defaults to Include for compatibility.