SearchResult

Represents a result found when searching for text.

Constructors

constructor(@IntRange(from = 0) pageIndex: Int, @NonNull textBlock: TextBlock, @Nullable snippet: SearchResult.TextSnippet, @Nullable annotation: Annotation, @NonNull document: PdfDocument)

Private constructor.

The TextSnippet can be extracted with a search result to present a preview text to the user.

Annotation that contains the search result.

@IntRange(from = 0)

Page number of the page holding the search result.

Search result snippet (preview text).

The search result text (containing the actual string, indices and text coordinates).

open fun create(@NonNull document: PdfDocument, @NonNull annotation: Annotation, @NonNull range: Range, @IntRange(from = 0) snippetLength: Int): SearchResult

Create an immutable search result with a preview snippet from annotation text.

open fun create(@NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, @NonNull range: Range, @IntRange(from = 0) snippetLength: Int): SearchResult

Creates an immutable search result with a preview snippet from page text