# WordImageOptimizationOptions

Managed embedded-media optimization settings. Changes remain in memory until a normal save.

Class 

`OfficeIMO.Word`

**Namespace**

`OfficeIMO.Word`

**Assembly**

`OfficeIMO.Word`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[WordImageOptimizationOptions.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L10)

**Modifiers**

sealed

Managed embedded-media optimization settings. Changes remain in memory until a normal save.

## Inheritance

- object
- WordImageOptimizationOptions

## Usage

Explore 3 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 [WordImageOptimizationOptions.Clone](/api/word/officeimo-word-wordimageoptimizationoptions/#method-clone)

### Accepted by parameters 2

- Method [WordDocument.AnalyzeImageOptimization](/api/word/officeimo-word-worddocument/#method-analyzeimageoptimization-officeimo-word-wordimageoptimizationoptions-threading-cancellationtoken) parameter `options`
- Method [WordDocument.OptimizeImages](/api/word/officeimo-word-worddocument/#method-optimizeimages-officeimo-word-wordimageoptimizationoptions-threading-cancellationtoken) parameter `options`

Filter members 

Show inherited

## Constructors

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

[WordImageOptimizationOptions.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L10)

## Methods

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

[WordImageOptimizationOptions.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L37)

Creates an independently validated copy of these settings.

Returns

`WordImageOptimizationOptions`

## 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)

[WordImageOptimizationOptions.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L8)

Defaults to placement-aware downsampling without same-size JPEG recompression.

`public double TargetDpi { get; set; }` [#](#property-targetdpi)

[WordImageOptimizationOptions.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L10)

Required pixels per displayed inch, between 36 and 1200. Defaults to 144.

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

[WordImageOptimizationOptions.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L12)

JPEG encoding quality, from 1 through 100. Defaults to 85.

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

[WordImageOptimizationOptions.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L14)

Preserves original bytes when the candidate is not smaller.

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

[WordImageOptimizationOptions.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L16)

Filtering used for pixel reduction.

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

[WordImageOptimizationOptions.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L18)

Metadata policy. Metadata loss blocks replacement unless explicitly allowed.

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

[WordImageOptimizationOptions.cs:20](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L20)

Categories retained by the selective metadata policy.

`public bool AllowMetadataLoss { get; set; }` [#](#property-allowmetadataloss)

[WordImageOptimizationOptions.cs:22](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L22)

Allows reported metadata loss, including intentional stripping. Defaults to false.

`public long MaxImageBytes { get; set; }` [#](#property-maximagebytes)

[WordImageOptimizationOptions.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L24)

Maximum encoded bytes read from one image part. Defaults to 32 MiB.

`public long MaxStagedBytes { get; set; }` [#](#property-maxstagedbytes)

[WordImageOptimizationOptions.cs:26](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L26)

Maximum combined original and candidate bytes retained for transactional replacement. Defaults to 128 MiB.

`public int MaxPackageParts { get; set; }` [#](#property-maxpackageparts)

[WordImageOptimizationOptions.cs:28](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L28)

Maximum package parts visited. Defaults to 10000.

`public OfficeSignatureMutationPolicy SignatureMutationPolicy { get; set; }` [#](#property-signaturemutationpolicy)

[WordImageOptimizationOptions.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word/WordImageOptimizationOptions.cs#L33)

How optimization handles digital signatures that replacing images would invalidate. The default blocks optimization of a signed document; pass the same policy to the save that persists the result.

<!-- PowerForge markdown artifact sha256:24205B6164B37EDBDD4662912804E5CAB8D072618A4FC8968C277F17D5D1A241 -->
