New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

Definition

Namespace:Telerik.Web.UI

Inheritance: Telerik.Web.UI.RadWebControlTelerik.Web.UI.RadSearchBox

Events

Adds a buttonCommand event handler for the radsearchbox

JS
add_buttonCommand
Parameters:handlerFunction

The event handler function to attach

Adds a dataRequesting event handler for the radsearchbox

JS
add_dataRequesting
Parameters:handlerFunction

The event handler function to attach

Adds a load event handler for the radsearchbox

JS
add_load
Parameters:handlerFunction

The event handler function to attach

Adds a search event handler for the radsearchbox

JS
add_search
Parameters:handlerFunction

The event handler function to attach

Removes a buttonCommand event handler from the radsearchbox

JS
remove_buttonCommand
Parameters:handlerFunction

The event handler function to remove

Removes a dataRequesting event handler from the radsearchbox

JS
remove_dataRequesting
Parameters:handlerFunction

The event handler function to remove

Removes a load event handler from the radsearchbox

JS
remove_load
Parameters:handlerFunction

The event handler function to remove

Removes a search event handler from the radsearchbox

JS
remove_search
Parameters:handlerFunction

The event handler function to remove

Methods

Clears the search results and closes the drop-down.

JS
clear(): void

Writes the changes to the searchBox that were made since a previous call to trackChanges, so that they are preserved over post-backs.

JS
commitChanges(): void

Gets a collection with all buttons

JS
get_buttons(): Telerik.Web.UI.SearchBoxButtonCollection
Returns:

Telerik.Web.UI.SearchBoxButtonCollection

Gets the UL DOM element of the RadSearchBox's drop-down

JS
get_childListElement(): Element
Returns:

Element

The UL DOM element of the RadSearchBox

Returns the value of the RadSearchBox's ClientTemplate property.

JS
get_clientTemplate(): String
Returns:

String

The value of the RadSearchBox

Gets the root DOM element of the RadSearchBox's drop-down.

JS
get_dropDownElement(): Element
Returns:

Element

The root DOM element of the RadSearchBox

Returns the value of the RadSearchBox's EmptyMessage property.

JS
get_emptyMessage(): String
Returns:

String

The value of the RadSearchBox

Gets a value indicating whether the AutoComplete functionality of the SearchBox is enabled

JS
get_enableAutoComplete(): Boolean
Returns:

Boolean

Value indicating whether the AutoComplete functionality of the SearchBox is enabled

Gets the value of the Enabled property

JS
get_enabled(): String
Returns:

String

Gets the Filter criteria of RadSearchBox.

JS
get_filter(): Telerik.Web.UI.SearchBoxFilter
Returns:

Telerik.Web.UI.SearchBoxFilter

Gets the input DOM element of the RadSearchBox.

JS
get_inputElement(): Element
Returns:

Element

The input DOM element of the RadSearchBox.

Returns the time in milliseconds before a request is initiated by the control after the user enters a keystroke.

JS
get_requestDelay(): Number
Returns:

Number

The time in milliseconds before a request is initiated by the control after the user enters a keystroke.

Gets the SearchContext's object

JS
get_searchContext(): Telerik.Web.UI.SearchContext
Returns:

Telerik.Web.UI.SearchContext

Gets the text in the input field.

JS
get_text(): String
Returns:

String

The text in the input field.

If AutoComplete is enabled,the search string exists and it is longer than the min filter length set, a search operation is performed. The second parameter defines whether all results should be shown in the drop-down.

JS
query(): void

Refreshes the RadSearchBox UI

JS
repaint(): void

Saves the client state to the client state hidden field

JS
saveClientState(): void

Sets the value of the RadSearchBox's ClientTemplate property.

JS
set_clientTemplate(String value): void
Parameters:valueString

value

Sets the value of the RadSearchBox's EmptyMessage property.

JS
set_emptyMessage(String value): void
Parameters:valueString

value

Sets whether the AutoComplete functionality of the SearchBox is enabled

JS
set_enableAutoComplete(Boolean value): void
Parameters:valueBoolean

Indicates whether the AutoComplete functionality of the SearchBox is enabled.

Toggles the enabled state of the RadSearchBox.

JS
set_enabled(): void

Sets the Filter criteria of RadSearchBox.

JS
set_filter(Telerik.Web.UI.SearchBoxFilter value): void
Parameters:valueTelerik.Web.UI.SearchBoxFilter

The Filter criteria.

Sets the time in milliseconds before a request is initiated by the control after the user enters a keystroke. Useful when requests overlap each other due to slower networks or when users with varying typing speeds encounter issues with the returned results for old searches.

JS
set_requestDelay(Number value): void
Parameters:valueNumber

The time in milliseconds before a request is initiated by the control after the user enters a keystroke.

Not finding the help you need?
Contact Support