<doc>

<legacy_id>1382</legacy_id>

<name>mouseDown</name>

<type>message</type>

<syntax>

<example>mouseDown <i>mouseButtonNumber</i></example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

</classification>

<references>

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

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

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

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

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

<property tag="repeatDelay">repeatDelay 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 when the user presses the <glossary tag="mouse button">mouse button</glossary>.</summary>

<examples>

<example>on mouseDown theButton <code><i>-- show popup menu on Control/Right-click</i></code></p><p> if theButton is 3 then popup button "Configure"</p><p> else pass mouseDown</p><p>end mouseDow</example>

</examples>

<description>

<p>Handle the <b>mouseDown</b> <keyword tag="message box">message</keyword> to perform an action when the user presses the <glossary tag="mouse button">mouse button</glossary>, before the <glossary tag="mouse button">mouse button</glossary> is released.</p><p/><p><b>Parameters:</b></p><p>The <i>mouseButtonNumber</i> specifies which <glossary tag="mouse button">mouse button</glossary> was pressed:</p><p> * 1 is the mouse button on Mac OS systems and the left button on Windows and Unix systems.</p><p> * 2 is the middle button on Unix systems.</p><p> * 3 is the right button on Windows and Unix systems and Control-click on Mac OS systems.</p><p/><p><b>Comments:</b></p><p>The <b>mouseDown</b> <keyword tag="message box">message</keyword> is sent to the <keyword tag="control">control</keyword> that was clicked, or to the <keyword tag="card">card</keyword> if no <keyword tag="control">control</keyword> was under the <glossary tag="mouse pointer">mouse pointer</glossary>.</p><p/><p>If the Browse tool is being used, and you click an unlocked field with mouse button 1 or 2, no <b>mouseDown</b> <keyword tag="message box">message</keyword> is sent. If you click with button 3, the <b>mouseDown</b> <keyword tag="message box">message</keyword> is sent even though the <keyword tag="field">field</keyword> is not <property tag="lockLocation">locked</property>.</p><p/><p><code/><img src="202653"/> <b>Important!</b><code/> If the user clicks a transparent <glossary tag="pixel">pixel</glossary> in an <keyword tag="image">image</keyword>, the <message tag="mouseDown">mouseDown</message> <keyword tag="message box">message</keyword> is sent to the <glossary tag="object">object</glossary> behind the <keyword tag="image">image</keyword>, not to the <keyword tag="image">image</keyword>.</p>

</description>

</doc>