<doc>

<legacy_id>2425</legacy_id>

<name>closeStackRequest</name>

<type>message</type>

<syntax>

<example>closeStackRequest</example>

</syntax>

<library></library>

<objects>

<card/>

</objects>

<synonyms>

</synonyms>

<classification>

<category>Windows Dialog Boxes</category>

<category>User Interaction</category>

</classification>

<references>

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

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

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

</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="current card">current card</glossary> when the user tries to close a <object tag="stack">stack</object>.</summary>

<examples>

<example>on closeStackRequest </p><p> answer "Are you sure?" with "No" or "Yes"</p><p> if it is "Yes" then pass closeStackRequest </p><p>end closeStackRequest</example>

</examples>

<description>

<p>Handle the <b>closeStackRequest</b> <keyword tag="message box">message</keyword> if you want to prevent a <object tag="stack">stack</object> from being closed.</p><p/><p><b>Comments:</b></p><p>If the <b>closeStackRequest</b> <glossary tag="handler">handler</glossary> does not <control_st tag="pass">pass</control_st> the <keyword tag="message box">message</keyword> or send it to a further <glossary tag="object">object</glossary> in the <glossary tag="message path">message path</glossary>, the <object tag="stack">stack</object> does not close. <glossary tag="pass">Passing</glossary> the <keyword tag="message box">message</keyword> allows the <object tag="stack">stack</object> to close. </p><p/><p>The <b>closeStackRequest</b> message is only sent if the request to close a stack is initiated by the user (eg by clicking file -&gt; close in the LiveCode menu). If the request is initiated from a script (eg "close this stack") then the <b>closeStackRequest</b> message is <b> not sent</b>.</p>

</description>

</doc>