<doc>

<legacy_id>2386</legacy_id>

<name>deleteKey</name>

<type>message</type>

<syntax>

<example>deleteKey</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

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

<message tag="backspaceKey">backspaceKey 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 the <glossary tag="active control">active (focused) control</glossary>, or to the <glossary tag="current card">current card</glossary> if there is no <glossary tag="active control">active control</glossary>.</summary>

<examples>

<example>on deleteKey <code><i>-- clear the entire field</i></code></p><p> if word 1 of the name of the target is "field" then</p><p> put empty into the target</p><p> end if</p><p>end deleteKey</example>

</examples>

<description>

<p>Handle the <b>deleteKey</b> <keyword tag="message box">message</keyword> if you want to do something special when the user presses the forward delete 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>The forward delete key is not the same as the backspace or delete key:</p><p> * The forward delete key is usually to the right of the main keyboard layout, and may be labeled with the word "Delete" or a left-facing arrow. Pressing it sends a <b>deleteKey</b> <keyword tag="message box">message</keyword>.</p><p> * The backspace key is usually on the main keyboard above the Return key, and is may be labeled "Backspace" or "Delete". Pressing it sends a <b>backspaceKey</b> <keyword tag="message box">message</keyword>.</p>

</description>

</doc>