# HtmlRenderEncoder

Identifies the output adapter intended to consume the retained render result.

Enum 

`OfficeIMO.Html`

**Namespace**

`OfficeIMO.Html`

**Assembly**

`OfficeIMO.Html`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

[HtmlRenderRequestClassification.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L38)

**Base**

`Enum`

**Implements**

`IComparable` `ISpanFormattable` `IFormattable` `IConvertible`

**Modifiers**

sealed

Identifies the output adapter intended to consume the retained render result.

## Inheritance

- Enum
- HtmlRenderEncoder

## Guides & Samples

Authored walkthroughs and practical samples linked to this API.

- [Read MHTML Web Archives and Site Bundles](/docs/html/mhtml-and-site-bundles/) Guide
  
  Open MHTML web archives or zipped websites, read their HTML and resources, create new archives, and convert them to PDF or images offline.

## Usage

Explore 14 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 12

- Property [HtmlRenderArchiveManifest.Encoder](/api/html/officeimo-html-htmlrenderarchivemanifest/#property-encoder)
- Field [HtmlRenderEncoder.DisplayList](/api/html/officeimo-html-htmlrenderencoder/#field-displaylist)
- Field [HtmlRenderEncoder.Geometry](/api/html/officeimo-html-htmlrenderencoder/#field-geometry)
- Field [HtmlRenderEncoder.HitTest](/api/html/officeimo-html-htmlrenderencoder/#field-hittest)
- Field [HtmlRenderEncoder.Jpeg](/api/html/officeimo-html-htmlrenderencoder/#field-jpeg)
- Field [HtmlRenderEncoder.Pdf](/api/html/officeimo-html-htmlrenderencoder/#field-pdf)
- Field [HtmlRenderEncoder.Png](/api/html/officeimo-html-htmlrenderencoder/#field-png)
- Field [HtmlRenderEncoder.Svg](/api/html/officeimo-html-htmlrenderencoder/#field-svg)
- Field [HtmlRenderEncoder.Tiff](/api/html/officeimo-html-htmlrenderencoder/#field-tiff)
- Field [HtmlRenderEncoder.Webp](/api/html/officeimo-html-htmlrenderencoder/#field-webp)
- Property [HtmlRenderProfileContract.Encoders](/api/html/officeimo-html-htmlrenderprofilecontract/#property-encoders)
- Property [HtmlRenderRequest.Encoder](/api/html/officeimo-html-htmlrenderrequest/#property-encoder)

### Accepted by parameters 2

- Method [HtmlRenderRequest.Create](/api/html/officeimo-html-htmlrenderrequest/#method-create-officeimo-html-htmlrenderintentprofile-officeimo-html-htmlrenderencoder-officeimo-html-htmlrenderoptions-officeimo-html-htmlrenderdocumentstate) parameter `encoder`
- Method [HtmlRenderRequest.WithEncoder](/api/html/officeimo-html-htmlrenderrequest/#method-withencoder-officeimo-html-htmlrenderencoder) parameter `encoder`

Filter members 

Show inherited

## Inherited Methods

`public int CompareTo(object? target)` [#](#method-compareto-object)

Inherited from Enum

Parameters

**target object? required**

Returns

`int`

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

Inherited from Enum

Parameters

**obj object? required**

Returns

`bool`

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

Inherited from Enum

Returns

`int`

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

Inherited from object

Returns

`Type`

`public TypeCode GetTypeCode()` [#](#method-gettypecode)

Inherited from Enum

Returns

`TypeCode`

`public bool HasFlag(Enum flag)` [#](#method-hasflag-enum)

Inherited from Enum

Parameters

**flag Enum required**

Returns

`bool`

ToString 4 overloads

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

Inherited from Enum

Returns

`string`

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

Inherited from Enum

Parameters

**format string? required**

Returns

`string`

`public string ToString(IFormatProvider? provider)` [#](#method-tostring-iformatprovider)

Inherited from Enum

`Obsolete("The provider argument is not used. Use ToString() instead.")`

Parameters

**provider IFormatProvider? required**

Returns

`string`

`public string ToString(string? format, IFormatProvider? provider)` [#](#method-tostring-string-iformatprovider)

Inherited from Enum

`Obsolete("The provider argument is not used. Use ToString(String) instead.")`

Parameters

**format string? required**

**provider IFormatProvider? required**

Returns

`string`

## Values

`public const HtmlRenderEncoder DisplayList` [#](#field-displaylist)

[HtmlRenderRequestClassification.cs:40](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L40)

Retain the backend-neutral display list.

Value: `0`

`public const HtmlRenderEncoder Png` [#](#field-png)

[HtmlRenderRequestClassification.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L42)

Encode one or more PNG images.

Value: `1`

`public const HtmlRenderEncoder Jpeg` [#](#field-jpeg)

[HtmlRenderRequestClassification.cs:44](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L44)

Encode one or more JPEG images.

Value: `2`

`public const HtmlRenderEncoder Tiff` [#](#field-tiff)

[HtmlRenderRequestClassification.cs:46](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L46)

Encode one or more TIFF images.

Value: `3`

`public const HtmlRenderEncoder Webp` [#](#field-webp)

[HtmlRenderRequestClassification.cs:48](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L48)

Encode one or more WebP images.

Value: `4`

`public const HtmlRenderEncoder Svg` [#](#field-svg)

[HtmlRenderRequestClassification.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L50)

Encode one or more SVG documents.

Value: `5`

`public const HtmlRenderEncoder Pdf` [#](#field-pdf)

[HtmlRenderRequestClassification.cs:52](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L52)

Encode a PDF document.

Value: `6`

`public const HtmlRenderEncoder Geometry` [#](#field-geometry)

[HtmlRenderRequestClassification.cs:54](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L54)

Consume the retained geometry and source identity.

Value: `7`

`public const HtmlRenderEncoder HitTest` [#](#field-hittest)

[HtmlRenderRequestClassification.cs:56](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderRequestClassification.cs#L56)

Consume the retained geometry through hit testing.

Value: `8`

<!-- PowerForge markdown artifact sha256:7254C6C1755AF0514FCD6C44A3CF1997B3F5C4F0229DCA102CEAA17FFC371793 -->
