Xojo Conferences

Platforms to show: All Mac Windows Linux Cross-Platform

MKLocalSearchCompleterMBS class

Type Topic Plugin Version macOS Windows Linux Console & Web iOS
class MapKit MBS MacFrameworks Plugin 19.0 Yes No No Yes, macOS only No
Function: A utility object for generating a list of completion strings based on a partial search string that you provide.
You use an MKLocalSearchCompleter object to retrieve auto-complete suggestions for your own map-based search controls. As the user types text, you feed the current text string into the search completer object, which delivers possible string completions that match locations or points of interest.

You create and configure MKLocalSearchCompleterMBS objects yourself. You should subclass this class to fill the event handler. You should also specify a search region to restrict results to a designated area.

Update the value of the completer’s queryFragment property to begin a search query. You can update this property in real time as the user types new characters into a text field because the completer object waits a short amount of time for the query string to stabilize. When modifications to the query strong stop, the completer initiates a new search and returns the results to your delegate as an array of MKLocalSearchCompletionMBS objects.

Feedback, Comments & Corrections

Filter Types

Constant Value Description
FilterTypeLocationsAndQueries 0 Points of interest and query suggestions. Specify this value when you want both map-based points of interest and common query terms used to find locations. For example, the search string “cof” yields a completion for “coffee”.
FilterTypeLocationsOnly 1 Points of interest only. Specify this value when you want the search string to yield completions that correspond to a specific point-of-interest on the map.

This class has no sub classes.

Some examples which use this class:

The items on this page are in the following plugins: MBS MacFrameworks Plugin.

MKGeodesicPolylineMBS   -   MKLocalSearchCompletionMBS

The biggest plugin in space...

MBS Xojo PDF Plugins