GemBox.PdfViewer
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    SearchEventMap Interface

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

    SearchEventMap is an interface used to provide type-safe event listeners and is not instantiated or used directly. It maps event names to their corresponding event object types and is consumed by addEventListener to ensure correct typing of listener callbacks.

    • TypeScript
    export declare interface SearchEventMap
    Remarks

    This interface defines the types of events that can be emitted during search operations, including when a search starts, is cancelled, or completes.

    Fields

    searchStarting

    Event emitted when a search operation is starting.

    • TypeScript
    searchStarting: SearchStartingEvent;
    Field Value
    SearchStartingEvent
    Remarks

    This event is fired before the actual search begins, allowing listeners to cancel or modify the search operation. The event contains the query text that will be searched for.

    searchCancelled

    Event emitted when a search operation is cancelled.

    • TypeScript
    searchCancelled: SearchCancelledEvent;
    Field Value
    SearchCancelledEvent
    Remarks

    This event is fired when an active search is cancelled, either by the user or programmatically. It indicates that no search results are currently available.

    searchCompleted

    Event emitted when a search operation completes.

    • TypeScript
    searchCompleted: SearchCompletedEvent;
    Field Value
    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.

    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.