<doc>
  <legacy_id>1496</legacy_id>
  <name>mouseControl</name>
  <type>function</type>
  <syntax>
    <example>the mouseControl</example>
    <example>mouseControl()</example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <function tag="mouseCharChunk">mouseCharChunk Function</function>
    <function tag="within">within Function</function>
    <keyword tag="control">control Keyword</keyword>
    <message tag="mouseLeave">mouseLeave Message</message>
    <message tag="mouseEnter">mouseEnter Message</message>
    <property tag="layer">layer 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><glossary tag="return">Returns</glossary> the number of the <keyword tag="control">control</keyword> the <glossary tag="mouse pointer">mouse pointer</glossary> is over.</summary>
  <examples>
    <example>the mouseControl</example>
    <example>if the number of the mouseControl is 2 then set the cursor to hand</example>
  </examples>
  <description>
    <p>Use the <b>mouseControl</b> <control_st tag="function">function</control_st> to change the <glossary tag="stack">stack's</glossary> behavior depending on what <keyword tag="control">control</keyword> the mouse is over, or to perform some action on the <keyword tag="control">control</keyword> the mouse is over.</p><p/><p><b>Value:</b></p><p>The <b>mouseControl</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> a <keyword tag="string">string</keyword> of the form<code> control <i>controlNumber</i></code>.</p><p/><p><b>Comments:</b></p><p>The control number returned in the <b>mouseControl</b> function is the same as the <glossary tag="control">control's</glossary> <property tag="layer">layer</property> <glossary tag="property">property</glossary>.</p><p/><p>If the mouse is not over a control, the <b>mouseControl</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> empty.</p><p/><p>If the mouse button is down, the <b>mouseControl</b> <control_st tag="function">function</control_st> <glossary tag="return">returns</glossary> the <keyword tag="control">control</keyword> that was clicked, even if the mouse has moved to another <keyword tag="control">control</keyword>.</p><p/><p>If the mouse is over a graphic that is not selected, its interior is considered to be within the graphic only if the graphic's <b>filled</b> <glossary tag="property">property</glossary> is true. If the <glossary tag="graphic">graphic's</glossary> <property tag="filled">filled</property> is false and the <keyword tag="graphic">graphic</keyword> is not selected, the <b>mouseControl</b> <glossary tag="return">returns</glossary> the <glossary tag="graphic">graphic's</glossary> number only if the mouse is over the <glossary tag="graphic">graphic's</glossary> border.</p>
  </description>
</doc>