ComPDFKit Web SDK
    Preparing search index...

    Interface SearchOptions

    Options of a text search.

    interface SearchOptions {
        ambientString?: boolean;
        caseSensitive?: boolean;
        regex?: boolean;
        searchUp?: boolean;
        wholeWord?: boolean;
        wildcard?: boolean;
    }
    Index
    ambientString?: boolean

    Includes the text around each hit in the result (step-by-step search only; full searches always include it).

    caseSensitive?: boolean

    Matches letter case exactly.

    regex?: boolean

    Treats the search term as a regular expression.

    searchUp?: boolean

    Searches backwards from the current position (step-by-step search only).

    wholeWord?: boolean

    Matches whole words only.

    wildcard?: boolean

    Treats the search term as a wildcard pattern.