<doc>

<legacy_id>1741</legacy_id>

<name>help</name>

<type>message</type>

<syntax>

<example>help</example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>User Interaction</category>

<category>Standalone Applications</category>

</classification>

<references>

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

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

</references>

<history>

<introduced version="1.0">Added.</introduced>

</history>

<platforms>

<mac/>

<windows/>

<linux/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

</classes>

<security>

</security>

<summary>Sent when the user presses the Help or F1 key.</summary>

<examples>

<example>on help </p><p> if the environment is "development"</p><p> then pass help</p><p> else go stack "My Help Tips"</p><p>end help</example>

</examples>

<description>

<p>Handle the <b>help</b> <keyword tag="message box">message</keyword> in order to substitute custom help for the LiveCode help system, or to provide help in a <glossary tag="standalone application">standalone application</glossary>.</p><p/><p><b>Comments:</b></p><p>The message is sent to the active (focused) control, or to the current card if no control is focused.</p>

</description>

</doc>