ImageGear .NET v25.2 - Updated
API Reference / ViewerControl API / IPCCSearch
In This Topic
    IPCCSearch
    In This Topic

    Namespace: IPCCSearch

    IPCCSearch

    ImageGear.Web Search

    Namespaces

    Combined
    Formatter
    Proximity
    Regex

    Type Definitions

    ProximityTerm

    Type:
    • Object
    Properties:
    Name Type Description
    pattern string String regular expression to search for.
    caseSensitive boolean Determines whether we consider case when matching this term.

    SearchInput

    Type:
    • Object
    Properties:
    Name Type Attributes Description
    type string The type of search to perform, can be "simple" or "proximity".
    pattern string <optional>
    String regular expression to search for. Required if `type` is "simple".
    caseSensitive boolean <optional>
    Determines whether we consider case when matching this term. Required if `type` is "simple".
    subTerms Array.<ProximityTerm> <optional>
    An array of search terms to consider for a proximity search. Required if `type` is "proximity".
    distance integer <optional>
    Maximum number of words allowed between any two consecutive search terms. Required if `type` is "proximity".

    SearchResult

    Type:
    • Object
    Properties:
    Name Type Attributes Description
    term string <optional>
    The string representation of the search regex. Only present for `regex` searches.
    input SearchInput <optional>
    Input object that produced this result. Only present for `combined` searches.
    text string The text of the result.
    startIndex integer Starting position of the result in the original text.

    Documentation generated by JSDoc 3.5.5 on Mon Feb 17 2025 09:01:57 GMT-0500 (Eastern Standard Time)