Table of Contents

Class SearchMatch

Namespace
PdfEngine.Text
Assembly
PdfEngine.Abstractions.dll

A search match hit across a PDF document with geometry and surrounding context.

public class SearchMatch
Inheritance
SearchMatch
Inherited Members

Properties

Bounds

The bounds as one rectangle in the same normalized coordinates.

public PdfRect Bounds { get; }

Property Value

PdfRect

CharacterIndex

The index of the first matched character in the page's character list.

public int CharacterIndex { get; set; }

Property Value

int

ContextSnippet

The page text around the match, on one line, for a result list.

public string ContextSnippet { get; set; }

Property Value

string

Height

The height, as a fraction of the displayed page height.

public double Height { get; set; }

Property Value

double

IsCurrentMatch

Set by a viewer for the match it shows now. The engine leaves it false.

public bool IsCurrentMatch { get; set; }

Property Value

bool

MatchLength

The number of matched characters.

public int MatchLength { get; set; }

Property Value

int

PageNumber

The page of the match, starting at 1.

public int PageNumber { get; set; }

Property Value

int

Text

The text that was searched for.

public string Text { get; set; }

Property Value

string

Width

The width, as a fraction of the displayed page width.

public double Width { get; set; }

Property Value

double

X

The left edge, as a fraction of the displayed page width (0 to 1, from the left).

public double X { get; set; }

Property Value

double

Y

The top edge, as a fraction of the displayed page height (0 to 1, from the top).

public double Y { get; set; }

Property Value

double