<doc>
  <legacy_id>2034</legacy_id>
  <name>toolTip</name>
  <type>property</type>
  <syntax>
    <example>set the toolTip of <i>object</i> to <i>string</i></example>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <message tag="help">help Message</message>
    <command tag="popup">popup Command</command>
    <command tag="show">show Command</command>
    <property tag="toolTipDelay">toolTipDelay Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Specifies the explanatory text that pops up in a small box when the user <property tag="points">points</property> to an <glossary tag="object">object</glossary>.</summary>
  <examples>
    <example>set the toolTip of button "OK" to "Click to accept the result"</example>
    <example>set the toolTip of me to field "Explanation"</example>
    <example>set the toolTip of me to "Hello" &amp; return &amp; "World!"</example>
  </examples>
  <description>
    <p>Use the <b>toolTip</b> <glossary tag="property">property</glossary> to provide online help that explains what a <keyword tag="control">control</keyword> is for.</p><p/><p><b>Value:</b></p><p>The <b>toolTip</b> of a <keyword tag="control">control</keyword> is a string.</p><p/><p><b>Comments:</b></p><p>A tool tip is a small box containing some text, which pops up on the screen when the mouse pointer hovers over a control. The text briefly explains the purpose and use of the control.</p><p/><p>The tool tip appears when the mouse pointer is within the control's rectangle and when the mouse has not moved for the time specified by the <b>toolTipDelay</b> <glossary tag="property">property</glossary>. If the mouse is moving, the <glossary tag="tool tip">tool tip</glossary> does not appear.</p><p/><p>Tool tips should be short and should not attempt to explain the entire action of the control. They are best used as a short reminder or clue about what a control does.</p><p/><p>Tool tips appear only when the Browse tool is selected.</p><p/><p><b>Note:</b> As of LiveCode version 2.7.4 toolTips can be multiline strings. Previous version restrict tooltips to single lines.</p>
  </description>
</doc>