<doc>

<legacy_id>1291</legacy_id>

<name>functionKey</name>

<type>message</type>

<syntax>

<example>functionKey <i>keyNumber</i></example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

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

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

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

<message tag="help">help 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 a function key.</summary>

<examples>

<example>on functionKey theKey</p><p> if theKey is 8 then showPaintTools <code><i>-- a custom handler</i></code></p><p> else pass functionKey</p><p>end functionKey</example>

</examples>

<description>

<p>Handle the <b>functionKey</b> <keyword tag="message box">message</keyword> to let the user perform some action with a function key.</p><p/><p><b>Parameters:</b></p><p>The <i>keyNumber</i> is the number of the function key.</p><p/><p><b>Comments:</b></p><p>The message is sent to the active (focused) control, or to the current card if no control is focused.</p><p/><p>Keyboards typically have twelve function keys, so you can use numbers from 1 to 12 to implement custom actions.</p>

</description>

</doc>