<doc>

<legacy_id>2391</legacy_id>

<name>enterKey</name>

<type>message</type>

<syntax>

<example>enterKey</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

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

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

</references>

<history>

<introduced version="1.0">Added.</introduced>

</history>

<platforms>

<mac/>

<windows/>

<linux/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

</classes>

<security>

</security>

<summary>Sent when the user presses the Enter key, if there is no text <keyword tag="selection">selection</keyword>.</summary>

<examples>

<example>on enterKey <code><i>-- in a stack script, closes the stack on Enter key</i></code></p><p> close me</p><p>end enterKey</example>

</examples>

<description>

<p>Handle the <b>enterKey</b> <keyword tag="message box">message</keyword> when you want to perform an action (such as going to the next <keyword tag="card">card</keyword>) when the user presses Enter .</p><p/><p><b>Comments:</b></p><p>The Enter key is usually located on the numeric keypad. It is a different key from the Return key (confusingly labeled "Enter" on some keyboards), which is usually located above the right-hand Shift key.</p><p/><p>The message is sent to the active (focused) control, or to the current card if no control is focused. If there is a text selection or insertion point in a field and the user presses Enter, the <b>enterInField</b> <keyword tag="message box">message</keyword> is sent to that <keyword tag="field">field</keyword>, and the <b>enterKey</b> <keyword tag="message box">message</keyword> is not sent.</p>

</description>

</doc>