# OfficeRasterDecodeOptions

Shared options for deterministic raster decoding.

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeRasterDecodeOptions.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L37)

**Modifiers**

sealed

Shared options for deterministic raster decoding.

## Inheritance

- object
- OfficeRasterDecodeOptions

## Usage

Explore 9 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.

### Returned or exposed by 1

- Method [OfficeRasterDecodeOptions.Clone](/api/core/officeimo-drawing-officerasterdecodeoptions/#method-clone)

### Accepted by parameters 8

- Method [OfficeImagePngConverter.TryConvertToPng](/api/core/officeimo-drawing-officeimagepngconverter/#method-tryconverttopng-byte-officeimo-drawing-officerasterdecodeoptions-byte-officeimo-drawing-officerasterdecodeinfo) parameter `options`
- Method [OfficeImageReader.NormalizeForEmbedding](/api/core/officeimo-drawing-officeimagereader/#method-normalizeforembedding-byte-officeimo-drawing-officerasterdecodeoptions-officeimo-drawing-officeimageinfo) parameter `options`
- Method [OfficeRasterContainerInspector.TryInspect](/api/core/officeimo-drawing-officerastercontainerinspector/#method-tryinspect-byte-officeimo-drawing-officerasterdecodeoptions-officeimo-drawing-officerastercontainerinfo) parameter `options`
- Method [OfficeRasterImageDecoder.Decode](/api/core/officeimo-drawing-officerasterimagedecoder/#method-decode-byte-officeimo-drawing-officerasterdecodeoptions) parameter `options`
- Method [OfficeRasterImageDecoder.DecodeFrames](/api/core/officeimo-drawing-officerasterimagedecoder/#method-decodeframes-io-stream-officeimo-drawing-officerasterdecodeoptions-officeimo-drawing-officerasterdecodeinfo-int32) parameter `options`
- Method [OfficeRasterImageDecoder.ReadEncodedBytes](/api/core/officeimo-drawing-officerasterimagedecoder/#method-readencodedbytes-io-stream-officeimo-drawing-officerasterdecodeoptions) parameter `options`
- Method [OfficeRasterImageDecoder.TryDecode](/api/core/officeimo-drawing-officerasterimagedecoder/#method-trydecode-io-stream-officeimo-drawing-officerasterdecodeoptions-officeimo-drawing-officerasterimage-officeimo-drawing-officerasterdecodeinfo) parameter `options`
- Method [OfficeRasterImageDecoder.TryDecodeFrames](/api/core/officeimo-drawing-officerasterimagedecoder/#method-trydecodeframes-byte-officeimo-drawing-officerasterdecodeoptions-officeimo-drawing-officerasterframes-officeimo-drawing-officerasterdecodeinfo-int32) parameter `options`

Filter members 

Show inherited

## Constructors

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

[OfficeRasterDecodeOptions.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L37)

## Methods

`public OfficeRasterDecodeOptions Clone()` [#](#method-clone)

[OfficeRasterDecodeOptions.cs:100](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L100)

Creates an independent settings snapshot, retaining the trusted codec and cancellation token by reference/value.

Returns

`OfficeRasterDecodeOptions`

## 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 int FrameIndex { get; set; }` [#](#property-frameindex)

[OfficeRasterDecodeOptions.cs:43](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L43)

Zero-based frame or page to decode.

`public OfficeRasterFrameLossPolicy FrameLossPolicy { get; set; }` [#](#property-framelosspolicy)

[OfficeRasterDecodeOptions.cs:52](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L52)

Behavior when the source contains more than one frame or page.

`public int MaximumEncodedBytes { get; set; }` [#](#property-maximumencodedbytes)

[OfficeRasterDecodeOptions.cs:64](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L64)

Maximum encoded bytes read or decoded by this request.

`public long MaximumDecodedPixels { get; set; }` [#](#property-maximumdecodedpixels)

[OfficeRasterDecodeOptions.cs:73](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L73)

Maximum decoded pixels retained by this request.

`public IOfficeRasterImageCodec? ImageCodec { get; set; }` [#](#property-imagecodec)

[OfficeRasterDecodeOptions.cs:83](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L83)

Optional trusted decoder for inspected raster payloads not decoded by the managed core.

`public CancellationToken CancellationToken { get; set; }` [#](#property-cancellationtoken)

[OfficeRasterDecodeOptions.cs:86](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L86)

Cancellation observed while reading, parsing, or decoding the request.

`public bool ApplyExifOrientation { get; set; }` [#](#property-applyexiforientation)

[OfficeRasterDecodeOptions.cs:91](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L91)

Whether orientation-aware decoders normalize EXIF display orientation; defaults to true.

`public bool JpegHighQualityChroma { get; set; }` [#](#property-jpeghighqualitychroma)

[OfficeRasterDecodeOptions.cs:97](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeRasterDecodeOptions.cs#L97)

Whether JPEG decoding interpolates subsampled chroma components; defaults to true.

<!-- PowerForge markdown artifact sha256:6D1659DFD89F2FF0AF03A2DF64E2C7D00A26BED45F89E5FAD67EAF916FEE759F -->
