SearchCompletedEvent Interface

Namespace:
@gembox/pdfviewer
Assembly:
@gembox/pdfviewer

Event emitted when a search operation completes.

export declare interface SearchCompletedEvent
Remarks

This event is fired after a search operation finishes, containing information about the search results including the query text, current match position, and total matches found.

Fields

query

The search query text that was used to find matches in the document.

readonly query: string;
Remarks

This property contains the actual query string that was searched for, allowing consumers of this event to know what text produced the results.

currentPosition

The current position/index of the selected search match (0-based).

readonly currentPosition: number;
Remarks

This property indicates which specific match is currently highlighted or selected in the document. It's useful for tracking navigation through search results.

matchCount

The total number of matches found for the search query.

readonly matchCount: number;
Remarks

This property provides the complete count of all occurrences of the search term throughout the entire document, allowing UI elements to display progress information.