# OfficeImageOptimizationRequest

Placement-derived policy for resizing and re-encoding an image.

Class 

`OfficeIMO.Drawing`

**Namespace**

`OfficeIMO.Drawing`

**Assembly**

`OfficeIMO.Core`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeImageOptimizer.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L23)

**Modifiers**

sealed

Placement-derived policy for resizing and re-encoding an image.

## Inheritance

- object
- OfficeImageOptimizationRequest

## 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 [OfficeImageOptimizer.Optimize](/api/core/officeimo-drawing-officeimageoptimizer/#method-optimize-byte-officeimo-drawing-officeimageoptimizationrequest-string) parameter `request`

Filter members 

Show inherited

## Constructors

`public OfficeImageOptimizationRequest(int targetPixelWidth, int targetPixelHeight)` [#](#constructor-ctor-int32-int32)

[OfficeImageOptimizer.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L23)

Creates an optimization request for a target pixel bounding box.

Parameters

**targetPixelWidth int required**

**targetPixelHeight int required**

## 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 OfficeImageOptimizationMode Mode { get; set; }` [#](#property-mode)

[OfficeImageOptimizer.cs:28](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L28)

Optimization mode. Downsample preserves the existing no-unnecessary-rewrite behavior.

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

[OfficeImageOptimizer.cs:31](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L31)

Cancellation observed during decoding, resampling, and encoding.

`public int TargetPixelWidth { get; set; }` [#](#property-targetpixelwidth)

[OfficeImageOptimizer.cs:41](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L41)

Maximum required output width in pixels.

`public int TargetPixelHeight { get; set; }` [#](#property-targetpixelheight)

[OfficeImageOptimizer.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L50)

Maximum required output height in pixels.

`public bool AllowUpscaling { get; set; }` [#](#property-allowupscaling)

[OfficeImageOptimizer.cs:58](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L58)

Allows enlarging source pixels when the placement is larger than the source.

`public bool PreserveAspectRatio { get; set; }` [#](#property-preserveaspectratio)

[OfficeImageOptimizer.cs:61](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L61)

Preserves the source aspect ratio within the requested pixel bounds.

`public OfficeRasterResamplingMode ResamplingMode { get; set; }` [#](#property-resamplingmode)

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

Sampling mode used when dimensions change.

`public OfficeRasterResamplingColorSpace ResamplingColorSpace { get; set; }` [#](#property-resamplingcolorspace)

[OfficeImageOptimizer.cs:67](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L67)

Color space used while filtering resized pixels.

`public OfficeImageFormat? OutputFormat { get; set; }` [#](#property-outputformat)

[OfficeImageOptimizer.cs:70](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L70)

Optional PNG, JPEG, TIFF, or WebP output override. Null preserves JPEG and otherwise emits PNG.

`public double? OutputDpiX { get; set; }` [#](#property-outputdpix)

[OfficeImageOptimizer.cs:77](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L77)

Optional horizontal output resolution. Null preserves source DPI. Values outside the selected destination format's metadata range are clamped to its nearest representable limit.

`public double? OutputDpiY { get; set; }` [#](#property-outputdpiy)

[OfficeImageOptimizer.cs:89](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L89)

Optional vertical output resolution. Null preserves source DPI. Values outside the selected destination format's metadata range are clamped to its nearest representable limit.

`public OfficePngCompression PngCompression { get; set; }` [#](#property-pngcompression)

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

PNG compression used when optimized output is PNG.

`public int JpegQuality { get; set; }` [#](#property-jpegquality)

[OfficeImageOptimizer.cs:101](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L101)

JPEG quality from 1 through 100.

`public OfficeJpegSubsampling JpegSubsampling { get; set; }` [#](#property-jpegsubsampling)

[OfficeImageOptimizer.cs:109](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L109)

JPEG chroma subsampling used for optimized output.

`public bool JpegProgressive { get; set; }` [#](#property-jpegprogressive)

[OfficeImageOptimizer.cs:112](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L112)

Writes progressive JPEG scans when optimized output is JPEG.

`public bool JpegOptimizeHuffman { get; set; }` [#](#property-jpegoptimizehuffman)

[OfficeImageOptimizer.cs:115](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L115)

Builds image-specific Huffman tables when optimized output is JPEG.

`public OfficeColor JpegBackground { get; set; }` [#](#property-jpegbackground)

[OfficeImageOptimizer.cs:118](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L118)

Background used when explicit JPEG output flattens alpha.

`public OfficeTiffCompression TiffCompression { get; set; }` [#](#property-tiffcompression)

[OfficeImageOptimizer.cs:121](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L121)

TIFF strip compression used when optimized output is TIFF.

`public OfficeTiffPredictor TiffPredictor { get; set; }` [#](#property-tiffpredictor)

[OfficeImageOptimizer.cs:124](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L124)

TIFF predictor applied when the selected compression supports it.

`public bool KeepOriginalWhenNotSmaller { get; set; }` [#](#property-keeporiginalwhennotsmaller)

[OfficeImageOptimizer.cs:127](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L127)

Keeps original bytes when the candidate would be the same size or larger.

`public OfficeImageMetadataPolicy MetadataPolicy { get; set; }` [#](#property-metadatapolicy)

[OfficeImageOptimizer.cs:130](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L130)

Metadata behavior used when new image bytes are encoded.

`public OfficeImageMetadataKinds MetadataSelection { get; set; }` [#](#property-metadataselection)

[OfficeImageOptimizer.cs:133](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Core/Raster/OfficeImageOptimizer.cs#L133)

Source categories copied when [OfficeImageOptimizationRequest.MetadataPolicy](/api/core/officeimo-drawing-officeimageoptimizationrequest/) is selective.

<!-- PowerForge markdown artifact sha256:CD19952C488C903FB43658ABA03D12DA0C7D10E0AFA1C85A10219F5B3D2FEE76 -->
