<doc>

<legacy_id>1938</legacy_id>

<name>deleteButton</name>

<type>message</type>

<syntax>

<example>deleteButton</example>

</syntax>

<library></library>

<objects>

<button/>

</objects>

<synonyms>

</synonyms>

<classification>

<category>Objects &amp; Messages</category>

</classification>

<references>

<command tag="delete">delete Command</command>

</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="button">button</keyword> just before it is removed from the <object tag="stack">stack</object>.</summary>

<examples>

<example>on deleteButton <code><i>-- prevent the deletion by immediately undoing it</i></code></p><p> beep</p><p> send "undo" to this card in 5 milliseconds</p><p>end deleteButton</example>

</examples>

<description>

<p>Handle the <b>deleteButton</b> message if you want to perform cleanup before a <keyword tag="button">button</keyword> is removed from the <object tag="stack">stack</object>.</p><p/><p><b>Comments:</b></p><p>The actual deletion is not triggered by the <b>deleteButton</b> <keyword tag="message box">message</keyword>, so <glossary tag="trap">trapping</glossary> the <keyword tag="message box">message</keyword> and not allowing it to <control_st tag="pass">pass</control_st> does not prevent the <keyword tag="button">button</keyword> from being removed.</p><p/><p>However, the <b>undo</b> <glossary tag="command">command</glossary> will restore a <keyword tag="button">button</keyword> after it is deleted by the user.</p>

</description>

</doc>