# HtmlRenderHitTestOptions

Limits and filters for one retained-scene hit test.

Class 

`OfficeIMO.Html`

**Namespace**

`OfficeIMO.Html`

**Assembly**

`OfficeIMO.Html`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

[HtmlRenderHitTesting.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L24)

**Modifiers**

sealed

Limits and filters for one retained-scene hit test.

## Inheritance

- object
- HtmlRenderHitTestOptions

## 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 [HtmlRenderHitTestOptions.WithMaximumResults](/api/html/officeimo-html-htmlrenderhittestoptions/#method-withmaximumresults-int32)

### Accepted by parameters 2

- Method [HtmlRenderSurface.HitTest](/api/html/officeimo-html-htmlrendersurface/#method-hittest-officeimo-html-htmlrenderpoint-officeimo-html-htmlrenderhittestoptions-threading-cancellationtoken) parameter `options`
- Method [HtmlRenderSurface.HitTestTopmost](/api/html/officeimo-html-htmlrendersurface/#method-hittesttopmost-officeimo-html-htmlrenderpoint-officeimo-html-htmlrenderhittestoptions-threading-cancellationtoken) parameter `options`

Filter members 

Show inherited

## Constructors

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

[HtmlRenderHitTesting.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L24)

## Methods

`public HtmlRenderHitTestOptions WithMaximumResults(int maximumResults)` [#](#method-withmaximumresults-int32)

[HtmlRenderHitTesting.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L36)

Returns an independent options copy with another result limit.

Parameters

**maximumResults int required**

Returns

`HtmlRenderHitTestOptions`

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

[HtmlRenderHitTesting.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L24)

Maximum topmost-first matches returned.

`public int MaximumVisitedVisuals { get; set; }` [#](#property-maximumvisitedvisuals)

[HtmlRenderHitTesting.cs:26](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L26)

Maximum scene nodes inspected before the report is marked truncated.

`public int MaximumPathSegments { get; set; }` [#](#property-maximumpathsegments)

[HtmlRenderHitTesting.cs:28](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L28)

Maximum flattened freeform clip-path line segments evaluated across one query.

`public bool InteractiveOnly { get; set; }` [#](#property-interactiveonly)

[HtmlRenderHitTesting.cs:30](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L30)

Return only links and retained form controls.

`public bool IncludeContainers { get; set; }` [#](#property-includecontainers)

[HtmlRenderHitTesting.cs:32](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L32)

Include grouping nodes in addition to leaf visuals and form controls.

## Fields

`public const int DefaultMaximumResults` [#](#field-defaultmaximumresults)

[HtmlRenderHitTesting.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L17)

Default maximum matches returned by one query.

Value: `32`

`public const int DefaultMaximumVisitedVisuals` [#](#field-defaultmaximumvisitedvisuals)

[HtmlRenderHitTesting.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L19)

Default maximum scene nodes visited by one query.

Value: `100000`

`public const int DefaultMaximumPathSegments` [#](#field-defaultmaximumpathsegments)

[HtmlRenderHitTesting.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Html/Rendering/HtmlRenderHitTesting.cs#L21)

Default maximum flattened clip-path line segments evaluated by one query.

Value: `100000`

<!-- PowerForge markdown artifact sha256:1C75C37FE46AB9F18B47032CD53B1B627A089D5A5273B67544782538E293C14D -->
