# HtmlRenderDocumentState

Identifies which kind of immutable document snapshot is supplied to a render operation.

Enum 

`OfficeIMO.Html`

**Namespace**

`OfficeIMO.Html`

**Assembly**

`OfficeIMO.Html`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

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

**Base**

`Enum`

**Implements**

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

**Modifiers**

sealed

Identifies which kind of immutable document snapshot is supplied to a render operation.

## Inheritance

- Enum
- HtmlRenderDocumentState

## Usage

Explore 8 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 6

- Property [HtmlRenderArchiveManifest.DocumentState](/api/html/officeimo-html-htmlrenderarchivemanifest/#property-documentstate)
- Field [HtmlRenderDocumentState.EditedSnapshot](/api/html/officeimo-html-htmlrenderdocumentstate/#field-editedsnapshot)
- Field [HtmlRenderDocumentState.ImportedCapture](/api/html/officeimo-html-htmlrenderdocumentstate/#field-importedcapture)
- Field [HtmlRenderDocumentState.RuntimeSnapshot](/api/html/officeimo-html-htmlrenderdocumentstate/#field-runtimesnapshot)
- Field [HtmlRenderDocumentState.StaticSource](/api/html/officeimo-html-htmlrenderdocumentstate/#field-staticsource)
- Property [HtmlRenderRequest.DocumentState](/api/html/officeimo-html-htmlrenderrequest/#property-documentstate)

### 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 `documentState`
- Method [HtmlRenderRequest.WithDocumentState](/api/html/officeimo-html-htmlrenderrequest/#method-withdocumentstate-officeimo-html-htmlrenderdocumentstate) parameter `state`

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 HtmlRenderDocumentState StaticSource` [#](#field-staticsource)

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

The inert source snapshot produced by parsing or loading HTML.

Value: `0`

`public const HtmlRenderDocumentState EditedSnapshot` [#](#field-editedsnapshot)

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

An OfficeIMO-owned snapshot produced after explicit DOM edits.

Value: `1`

`public const HtmlRenderDocumentState ImportedCapture` [#](#field-importedcapture)

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

A frozen document imported from another capture provider.

Value: `2`

`public const HtmlRenderDocumentState RuntimeSnapshot` [#](#field-runtimesnapshot)

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

A frozen snapshot captured from an OfficeIMO HTML runtime session.

Value: `3`

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