# ReaderExcelOptions

Controls Excel workbook projection into Reader chunks.

Class 

`OfficeIMO.Reader.Excel`

**Namespace**

`OfficeIMO.Reader.Excel`

**Assembly**

`OfficeIMO.Reader.Excel`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[ReaderExcelOptions.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Excel/ReaderExcelOptions.cs#L17)

**Modifiers**

sealed

Controls Excel workbook projection into Reader chunks.

## Inheritance

- object
- ReaderExcelOptions

## Usage

Explore 4 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Accepted by parameters 4

- Method [ExcelDocumentReaderExtensions.ReadDocument](/api/reader-excel/officeimo-reader-excel-exceldocumentreaderextensions/#method-readdocument-officeimo-excel-exceldocument-string-officeimo-reader-readeroptions-officeimo-reader-excel-readerexceloptions-threading-cancellationtoken) parameter `formatOptions`
- Method [OfficeDocumentReaderBuilderExcelExtensions.AddExcelAndLegacyHandlers](/api/reader-excel/officeimo-reader-excel-officedocumentreaderbuilderexcelextensions/#method-addexcelandlegacyhandlers-officeimo-reader-officedocumentreaderbuilder-officeimo-excel-legacy-legacyspreadsheetimportoptions-officeimo-reader-excel-readerexceloptions-boolean) parameter `options`
- Method [OfficeDocumentReaderBuilderExcelExtensions.AddExcelHandler](/api/reader-excel/officeimo-reader-excel-officedocumentreaderbuilderexcelextensions/#method-addexcelhandler-officeimo-reader-officedocumentreaderbuilder-officeimo-reader-excel-readerexceloptions-boolean) parameter `options`
- Method [OfficeDocumentReaderBuilderExcelExtensions.AddLegacySpreadsheetHandler](/api/reader-excel/officeimo-reader-excel-officedocumentreaderbuilderexcelextensions/#method-addlegacyspreadsheethandler-officeimo-reader-officedocumentreaderbuilder-officeimo-excel-legacy-legacyspreadsheetimportoptions-officeimo-reader-excel-readerexceloptions-boolean) parameter `options`

Filter members 

Show inherited

## Constructors

`public ReaderExcelOptions()` [#](#constructor-ctor)

[ReaderExcelOptions.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Excel/ReaderExcelOptions.cs#L17)

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public string? SheetName { get; set; }` [#](#property-sheetname)

[ReaderExcelOptions.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Excel/ReaderExcelOptions.cs#L8)

Optional worksheet name. All worksheets are read when omitted.

`public int? SheetNumber { get; set; }` [#](#property-sheetnumber)

[ReaderExcelOptions.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Excel/ReaderExcelOptions.cs#L11)

Optional one-based worksheet position. Cannot be combined with SheetName.

`public string? A1Range { get; set; }` [#](#property-a1range)

[ReaderExcelOptions.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Excel/ReaderExcelOptions.cs#L14)

Optional A1 range applied to each selected worksheet.

`public bool HeadersInFirstRow { get; set; }` [#](#property-headersinfirstrow)

[ReaderExcelOptions.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Excel/ReaderExcelOptions.cs#L17)

Treats the first range row as column names.

`public int ChunkRows { get; set; }` [#](#property-chunkrows)

[ReaderExcelOptions.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Excel/ReaderExcelOptions.cs#L20)

Number of source rows requested per extraction chunk.

`public ExcelReaderOptions? ReadOptions { get; set; }` [#](#property-readoptions)

[ReaderExcelOptions.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Reader.Excel/ReaderExcelOptions.cs#L23)

Optional low-level Excel read policy.

<!-- PowerForge markdown artifact sha256:8884748EFCE1FCD899E83086BEEB23977E4F677EFDD5D29C3765F3BF0BC255CE -->
