<doc>

<legacy_id>1110</legacy_id>

<name>enterInField</name>

<type>message</type>

<syntax>

<example>enterInField</example>

</syntax>

<library></library>

<objects>

<field/>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

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

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

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

<property tag="default">default Property</property>

<property tag="allowKeyInField">allowKeyInField Property</property>

</references>

<history>

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

</history>

<platforms>

<mac/>

<windows/>

<linux/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

</classes>

<security>

</security>

<summary>Sent to the <keyword tag="field">field</keyword> with the current <keyword tag="selection">selection</keyword> when the user presses the Enter key.</summary>

<examples>

<example>on enterInField <code><i>-- add up the lines in the current field</i></code></p><p> put sum(replaceText(target,return,comma)) into field "Sum"</p><p>end enterInField</example>

</examples>

<description>

<p>Handle the <b>enterInField</b> <keyword tag="message box">message</keyword> when you want to perform an action when the user presses Enter in a <keyword tag="field">field</keyword>.</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>If the <b>enterInField</b> <glossary tag="handler">handler</glossary> does not <control_st tag="pass">pass</control_st> the <keyword tag="message box">message</keyword> or send it to a further <glossary tag="object">object</glossary> in the <glossary tag="message path">message path</glossary>, the keypress has no effect. <glossary tag="pass">Passing</glossary> the <keyword tag="message box">message</keyword> allows the keypress to have its normal effect.</p><p/><p>If there is no selection or insertion point in any field and the user presses Enter, the <b>enterKey</b> <keyword tag="message box">message</keyword> is sent instead of <b>enterInField</b>.</p>

</description>

</doc>