Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for providing search hints given a search string. Not to be confused with actual search results, search hints are simply strings of things that are related to or match the provided search text. A typical use of search hints is in an auto-complete drop down box.

This interface is a companion to SearchProviderBase. If a class extends SearchProviderBase, then it might optionally implement this interface to provide search hints. It's up to the consumer of the search provider to actually make use of this functionality. In the HTML5 viewer, SearchManager manages the search providers and exposes the associated SearchHintProvider implementations.

Hierarchy

  • SearchHintProvider

Index

Methods

Methods

getSearchHints

  • Returns a collection of strings that match or are related to the provided search text. This is typically used for auto complete dropdown boxes.

    Parameters

    • hints: ObservableCollection<SearchHintItem>

      The collection of hints. This collection should be manipulated (added) to by the implementation.

    • searchText: string

      The text the user is searching on.

    Returns void