Skip to content

TTMSFMXNativeUISearchBar

Usage

The TMSFMXNativeUISearchbar implements a text field control for text-based searches. The control provides a text field for entering text, a search button, a bookmark button, and a cancel button. The SearchBar does not actually perform any searches. Events can be used to implement the actions when text is entered and buttons are clicked.

Published Properties

Property name Description
PlaceHolder The string that is displayed when there is no other text in the text field.
Prompt A single line of text displayed at the top of the search bar.
SearchResultsButtonSelected A Boolean value indicating whether the search results button is selected or not.
ShowsBookMarkButton A Boolean value indicating whether the bookmark button is displayed or not.
ShowsCancelButton A Boolean value indicating whether the cancel button is displayed or not.
ShowsSearchResultsButton A Boolean value indicating whether the search results button is displayed or not.
Style The style that specifies the toolbar appearance.
TintColor The color used to tint the toolbar.
Text The current or starting search text.
Translucent Specifies whether the toolbar is translucent or not.
Visible Shows or hides the SearchBar.

Public Properties

Property name Description
SearchBar Returns a reference to the native iOS UISearchBar.

Events

Event name Description
OnBookmarkButtonClicked Event called when the bookmark button is clicked.
OnCancelButtonClicked Event called when the cancel button is clicked.
OnResultsListButtonClicked Event called when the results list button is clicked.
OnSearchButtonClicked Event called when the search button is clicked.
OnSelectedScopeButtonIndexDidChange Event called when the selected scope changed.
OnShouldBeginEditing Event called when the editing should begin.
OnShouldChangeTextInRange Event called when the text in range should be changed.
OnShouldEndEditing Event called when the editing should end.
OnTextDidBeginEditing Event called when the editing of the text did begin.
OnTextDidChange Event called when the text did change.
OnTextDidEndEditing Event called when the editing of the text did end.