SearchBox.onreceivingfocusonkeyboardinput event

Applies to Windows only

Raised when the app automatically redirects focus to the search box. This event can only be raised when the focusOnKeyboardInput property is set to true.

Syntax


<div 
    data-win-control="WinJS.UI.SearchBox" 
    data-win-options="{onreceivingfocusonkeyboardinput : handler}">
</div>


function handler(eventInfo) { /* Your code */ }
 
// addEventListener syntax
searchBox.addEventListener("receivingfocusonkeyboardinput", handler);
searchBox.removeEventListener("receivingfocusonkeyboardinput", handler);


Event information

SynchronousNo
BubblesYes
CancelableYes

 

Event handler parameters

eventInfo

Type: CustomEvent

An object that contains information about the event. The detail property of this object contains the following sub-properties:

detail.propertyName

Remarks

Apps that want "type-to-search" behavior should handle this event and synchronously ensure the control is visible before the event call completes. After this event is raised, the control will set focus to itself.

Requirements

Minimum supported client

Windows 8.1 [Windows Store apps only]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps only]

Minimum supported phone

None supported

Namespace

WinJS.UI

Library

Ui.js

See also

SearchBox

 

 

Show:
© 2014 Microsoft