Method FindNear

Namespace

LMKit.Document.Search

Assembly

LM-Kit.NET.dll

FindNear(PageElement, string, ProximityOptions)

Finds instances of query located within a proximity of the specified anchor region.

public List<TextMatch> FindNear(PageElement page, string query, ProximityOptions options)

Parameters

page PageElement

The page to search. Must not be null.

query string

Query text to match near the anchor region.

options ProximityOptions

Proximity and text options (anchor region required).

Returns

List<TextMatch>

Matches whose contributing elements lie near the given anchor region (possibly empty).

Exceptions

ArgumentNullException

Thrown when page or options is null.

FindNear(IEnumerable<PageElement>, string, ProximityOptions)

Finds instances of query located within a proximity of the specified anchor region across multiple pages. The same anchor region and radius are applied to each page independently (page-local coordinates).

public List<TextMatch> FindNear(IEnumerable<PageElement> pages, string query, ProximityOptions options)

Parameters

pages IEnumerable<PageElement>

Pages to search. Must not be null.

query string

Query text to match near the anchor region.

options ProximityOptions

Proximity and text options (anchor required). May be null for defaults (but must include an anchor region).

Returns

List<TextMatch>

All proximity matches across pages with (TextMatch) with PageIndex set.

Exceptions

ArgumentNullException

Thrown when pages is null.