<doc>
  <legacy_id>1504</legacy_id>
  <name>acceleratorText</name>
  <type>property</type>
  <syntax>
    <example>set the accel[erator]Text of <i>button</i> to <i>string</i></example>
  </syntax>
  <library></library>
  <objects>
    <button/>
  </objects>
  <synonyms>
    <synonym>accelText</synonym>
  </synonyms>
  <classification>
    <category>User Interaction</category>
  </classification>
  <references>
    <property tag="acceleratorKey">acceleratorKey Property</property>
    <property tag="acceleratorModifiers">acceleratorModifiers Property</property>
    <property tag="label">label Property</property>
    <property tag="mnemonic">mnemonic Property</property>
    <property tag="rightMargin">rightMargin Property</property>
    <property tag="textAlign">textAlign Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Specifies the shortcut hint that appears at the right edge of a <keyword tag="button">button</keyword>.</summary>
  <examples>
    <example>set the acceleratorText of button 3 to "A"</example>
    <example>set the accelText of button "Go" to field "Shortcut Key"</example>
    <example>set the accelText of button 9 to "option-D"</example>
    <example>set the accelText of the mouseControl to empty <i>-- remove acceleratorText</i></example>
  </examples>
  <description>
    <p>Use the <b>acceleratorText</b> <glossary tag="property">property</glossary> to provide the user with an onscreen hint about the shortcut <glossary tag="key combination">key combination</glossary> specified by the button's <property tag="acceleratorKey">acceleratorKey</property> <glossary tag="property">property</glossary>.</p><p/><p><b>Value:</b></p><p>The <b>acceleratorText</b> of a <keyword tag="button">button</keyword> is a <keyword tag="string">string</keyword>, or an expression that evaluates to a string.</p><p/><p>By default, the <b>acceleratorText</b> of a newly created button is empty.</p><p/><p><b>Comments:</b></p><p>The <b>acceleratorText</b> string appears at the right edge of the <keyword tag="button">button</keyword>, inside the <glossary tag="button">button's</glossary> <property tag="rightMargin">rightMargin</property>. LiveCode does not automatically make room for the <b>acceleratorText</b> <keyword tag="string">string</keyword>, so you might need to enlarge the <keyword tag="button">button</keyword> to prevent its label from overlapping the <b>acceleratorText</b> <keyword tag="string">string</keyword>.</p><p/><p>If the button's <b>textAlign</b> <glossary tag="property">property</glossary> is set to "right", the <glossary tag="button">button's</glossary> label overlaps the <b>acceleratorText</b> <keyword tag="string">string</keyword>, so you shouldn't set a <glossary tag="button">button's</glossary> <b>acceleratorText</b> if it has a right-aligned label.</p><p/><p>Usually, the <i>string</i> should be the <keyword tag="character">character</keyword> in <property tag="acceleratorKey">acceleratorKey</property>, but you might want to include additional <keyword tag="characters">characters</keyword> to hint at the <glossary tag="modifier key">modifier key</glossary> needed.</p><p/><p><b>Note:</b> Nothing happens when the user presses the key specified by the <b>acceleratorText</b> <glossary tag="property">property</glossary> unless the <property tag="acceleratorKey">acceleratorKey</property> and <property tag="acceleratorModifiers">acceleratorModifiers</property> are set. The <b>acceleratorText</b> <glossary tag="property">property</glossary> creates a visual hint, but does not create the actual shortcut <glossary tag="key combination">key combination</glossary>.</p>
  </description>
</doc>