# ReaderImageOptions

Controls standalone image projection into the Reader document model.

Class 

`OfficeIMO.Reader.Image`

**Namespace**

`OfficeIMO.Reader.Image`

**Assembly**

`OfficeIMO.Reader.Image`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

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

**Modifiers**

sealed

Controls standalone image projection into the Reader document model.

## Inheritance

- object
- ReaderImageOptions

## Usage

Explore 1 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 1

- Method [OfficeDocumentReaderBuilderImageExtensions.AddImageHandler](/api/reader-image/officeimo-reader-image-officedocumentreaderbuilderimageextensions/#method-addimagehandler-officeimo-reader-officedocumentreaderbuilder-officeimo-reader-image-readerimageoptions-boolean) parameter `imageOptions`

Filter members 

Show inherited

## Constructors

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

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

## 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 bool IncludePayload { get; set; }` [#](#property-includepayload)

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

Gets or sets whether the source bytes are retained as a materializable document asset. Default: true.

`public bool CreateOcrCandidate { get; set; }` [#](#property-createocrcandidate)

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

Gets or sets whether an OCR candidate is emitted for a retained image payload. Default: true. This does not execute OCR or configure an OCR engine.

`public OfficeImageMetadataInspectionOptions MetadataInspection { get; set; }` [#](#property-metadatainspection)

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

Owner-level metadata limits used when ReaderOptions.Inspection is enabled.

<!-- PowerForge markdown artifact sha256:98F72DAE9CF18492895E014D2EE7B6E169D17FBEF8FC863EFD0585C522E88B98 -->
