<doc>

<legacy_id>1648</legacy_id>

<name>arrowKey</name>

<type>message</type>

<syntax>

<example>arrowKey {up | down | left | right}</example>

</syntax>

<library></library>

<objects>

<button/>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

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

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

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

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

</references>

<history>

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

</history>

<platforms>

<mac/>

<windows/>

<linux/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

</classes>

<security>

</security>

<summary>the <glossary tag="active control">active (focused) control</glossary>, or to the <glossary tag="current card">current card</glossary> if no <keyword tag="control">control</keyword> is <glossary tag="focus">focused</glossary>, when the user presses an arrow key.</summary>

<examples>

<example>on arrowKey theKey <i>-- make Up arrow go to the first card</i></p><p> if theKey is "up" then go to card 1</p><p> else pass arrowKey</p><p>end arrowKey</example>

</examples>

<description>

<p>Handle the <b>arrowKey</b> <keyword tag="message box">message</keyword> if you want to do something special when the user presses an arrow key.</p><p/><p><b>Parameters:</b></p><p>The parameter indicates which arrow key was pressed.</p><p/><p><b>Comments:</b></p><p>If the <b>arrowKey</b> <glossary tag="handler">handler</glossary> does not <control_st tag="pass">pass</control_st> the <keyword tag="message box">message</keyword> or <command tag="send">send</command> it to a further <glossary tag="object">object</glossary> in the <glossary tag="message path">message path</glossary>, LiveCode does not perform the usual arrow key action (moving the <glossary tag="insertion point">insertion point</glossary>, moving the <property tag="selected">selected</property> <glossary tag="object">object</glossary>, or navigating to another card). <glossary tag="pass">Passing</glossary> the <keyword tag="message box">message</keyword> lets the arrow key action take place.</p><p/><p>If the focused control is part of a group, and the group's <b>tabGroupBehavior</b> <glossary tag="property">property</glossary> is set to true, no <b>arrowKey</b> <keyword tag="message box">message</keyword> is sent when the user presses an arrow key.</p><p/><p><b>Note:</b> Sending an <b>arrowKey</b> message does nothing unless there is an <b>arrowKey</b> <glossary tag="handler">handler</glossary> in the <glossary tag="message path">message path</glossary>. This is a difference from <glossary tag="HyperCard">HyperTalk's</glossary> handling of the <b>arrowKey</b> <keyword tag="message box">message</keyword>.</p>

</description>

</doc>