<doc>
  <legacy_id>2050</legacy_id>
  <name>returnInField</name>
  <type>message</type>
  <syntax>
    <example>returnInField</example>
  </syntax>
  <library></library>
  <objects>
    <field/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <message tag="enterInField">enterInField Message</message>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Sent to a <keyword tag="field">field</keyword> when the <keyword tag="selection">selection</keyword> is in the <keyword tag="field">field</keyword> and the user presses the Return key.</summary>
  <examples>
    <example>on returnInField <code><i>-- automatically re-sort a field when a line is added</i></code></p><p>  sort lines of the target</p><p>end returnInField</example>
  </examples>
  <description>
    <p>Handle the <b>returnInField</b> <keyword tag="message box">message</keyword> when you want to perform an action (such as adding a column of figures) when the user presses Return in a <keyword tag="field">field</keyword>.</p><p/><p><b>Comments:</b></p><p>The Return key (confusingly labeled "Enter" on some keyboards) is usually located above the right-hand Shift key. It is the key you press to go to a new line.</p><p/><p>If the <b>returnInField</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>The <b>returnInField</b> <keyword tag="message box">message</keyword> is sent to <glossary tag="button">buttons</glossary> whose <property tag="menuMode">menuMode</property> is "comboBox", since the type-in box in a <glossary tag="combo box">combo box</glossary> behaves like a <keyword tag="field">field</keyword>.</p><p/><p>If there is no selection or insertion point in any field and the user presses Return, the <b>returnKey</b> <keyword tag="message box">message</keyword> is sent instead of <b>returnInField</b>.</p>
  </description>
</doc>