<doc>

<legacy_id>2339</legacy_id>

<name>commandKeyDown</name>

<type>message</type>

<syntax>

<example>commandKeyDown <i>keyName</i></example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

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

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

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

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

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

</references>

<history>

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

</history>

<platforms>

<mac/>

<windows/>

<linux/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

</classes>

<security>

</security>

<summary>Sent when a Command <glossary tag="key combination">key combination</glossary> (Control-key on <glossary tag="Unix">Unix</glossary> or <function tag="openStacks">Windows</function>) is pressed.</summary>

<examples>

<example>on commandKeyDown theKey <code><i>-- make Command-5 go back</i></code></p><p> if theKey is "5" then go recent card else pass commandKeyDown</p><p>end commandKeyDown</example>

</examples>

<description>

<p>Handle the <b>commandKeyDown</b> message if you want to provide Command-key or Control-key shortcuts (other than those provided in <function tag="menus">menus</function> and <keyword tag="button">button</keyword> accelerators).</p><p/><p><b>Parameters:</b></p><p>The <i>keyName</i> is the actual <keyword tag="character">character</keyword> of the pressed key.</p><p/><p><b>Comments:</b></p><p>The <b>commandKeyDown</b> <keyword tag="message box">message</keyword> is sent to 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>.</p><p/><p>If the Command key is pressed along with the Return, Tab, Backspace, Delete, or Enter key, with an arrow key, or with a function key, no <b>commandKeyDown</b> <keyword tag="message box">message</keyword> is sent. Instead, the <message tag="returnKey">returnKey</message>, <message tag="tabKey">tabKey</message>, <message tag="backspaceKey">backspaceKey</message>, <message tag="deleteKey">deleteKey</message>, <message tag="enterKey">enterKey</message>, <message tag="arrowKey">arrowKey</message> or <message tag="functionKey">functionKey</message> <keyword tag="message box">message</keyword> is sent. To trap a combination such as Command-Return or Control-Return, use a <message tag="returnKey">returnKey</message> <glossary tag="handler">handler</glossary> and check the <function tag="commandKey">commandKey</function> <control_st tag="function">function</control_st> inside the <glossary tag="handler">handler</glossary>.</p><p/><p><code/><img src="202652"/> <b>Cross-platform note:</b><code/> On <glossary tag="Mac OS">Mac OS systems</glossary>, the <b>commandKeyDown</b> <keyword tag="message box">message</keyword> is sent when the user presses a key while holding down the <glossary tag="Command key">Command key</glossary>. On <glossary tag="Unix">Unix</glossary> or <glossary tag="Windows">Windows systems</glossary>, the <b>commandKeyDown</b> <keyword tag="message box">message</keyword> is sent when the user presses the Control key, whether or not another key is pressed at the same time.</p>

</description>

</doc>