<doc>

<legacy_id></legacy_id>

<name>inputReturnKey</name>

<type>message</type>

<syntax>

<example>inputReturnKey</example>

</syntax>

<synonyms>

</synonyms>

<summary>Sent when the return key is pressed and focus is removed from an mobile text input control.</summary>

<examples>

<example><p>on inputReturnKey -- <i>save the details when the return key is pressed, then focus on the next control</i></p><p> saveUserName</p><p> mobileControlDo tEmailFieldID, &quot;focus&quot;</p><p>end inputReturnKey</p></example>

</examples>

<history>

<introduced version="4.6">Added</introduced>

<deprecated version=""></deprecated>

<removed version=""></removed>

<changed version="5.5.1">Android Support Added</changed>

</history>

<objects>

<iosTextInput/>

<androidTextInput/>

<androidMultiline/>

</objects>

<platforms>

<ios/>

<android/>

</platforms>

<classes>

<mobile/>

</classes>

<security>

</security>

<classification>

</classification>

<references>

<function tag="mobileControlGet">mobileControlGet Function</function>

<function tag="mobileControlTarget">mobileControlTarget Function</function>

<function tag="mobileControls">mobileControls Function</function>

<command tag="mobileControlCreate">mobileControlCreate Command</command>

<command tag="mobileControlDelete">mobileControlDelete Command</command>

<command tag="mobileControlSet">mobileControlSet Command</command>

<message tag="inputBeginEditing">inputBeginEditing Message</message>

<message tag="inputEndEditing">inputEndEditing Message</message>

<message tag="inputTextChanged">inputTextChanged Message</message>

</references>

<description>

<overview>The <b>inputReturnKey</b> message is sent when the return key is pressed and focus is removed from the mobile text input control.</overview>

<parameters>

</parameters>

<value></value>

<comments>Handle the <b>inputReturnKey</b> message if you want to make changes to the interface or perform an action when the return key is pressed and focus is removed from an iosTextInput, androidTextInput or androidMultiline control.<p></p><p>The <b>inputReturnKey</b> message is sent to the object containing the script that created the text input control.</p></comments>

</description>

</doc>