<doc>
  <legacy_id>1179</legacy_id>
  <name>hilitedButton</name>
  <type>property</type>
  <syntax>
    <example>set the hilitedButton of <i>group</i> to <i>buttonNumber</i></example>
  </syntax>
  <library></library>
  <objects>
    <group/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Appearance &amp; Positioning</category>
  </classification>
  <references>
    <function tag="selectedButton">selectedButton Function</function>
    <property tag="hilitedButtonName">hilitedButtonName 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>Specifies which <keyword tag="button">button</keyword> in a <command tag="group">group</command> is currently <property tag="hilite">highlighted</property>.</summary>
  <examples>
    <example>set the hilitedButton of group "Options" to 2 <code><i>-- 2nd button in group</i></code></example>
    <example>set the hilitedButton of group ID 8 to zero <code><i>-- unhilites all buttons</i></code></example>
  </examples>
  <description>
    <p>Use the <b>hilitedButton</b> <glossary tag="property">property</glossary> to change the current setting in a <glossary tag="radio button">radio-button cluster</glossary>.</p><p/><p><b>Value:</b></p><p>The <b>hilitedButton</b> of a <command tag="group">group</command> is an <keyword tag="integer">integer</keyword> between zero and the number of <glossary tag="button">buttons</glossary> in the <command tag="group">group</command>.</p><p/><p><b>Comments:</b></p><p>The <b>hilitedButton</b> specifies which <keyword tag="button">button</keyword> in a <command tag="group">group</command> is currently <property tag="hilite">highlighted</property>. If the <b>hilitedButton</b> of a <command tag="group">group</command> is zero, none of the <glossary tag="button">buttons</glossary> in the <command tag="group">group</command> is currently <property tag="hilite">highlighted</property>. If the <b>hilitedButton</b> is 1, the <keyword tag="button">button</keyword> with the lowest <property tag="layer">layer</property> in the <command tag="group">group</command> is currently <property tag="hilite">highlighted</property>; if the <b>hilitedButton</b> is 2, the <keyword tag="button">button</keyword> with the second-lowest <property tag="layer">layer</property> is currently <property tag="hilite">highlighted</property>; and so forth.</p><p/><p>Setting the <b>hilitedButton</b> of a <command tag="group">group</command> sets the <command tag="hilite">hilite</command> <glossary tag="property">property</glossary> of the rest of the <glossary tag="button">buttons</glossary> to false.</p><p/><p>The <b>hilitedButton</b> <glossary tag="property">property</glossary> is most useful in <glossary tag="radio button">radio-button clusters</glossary>. In a <glossary tag="radio button">radio-button cluster</glossary>, only one <keyword tag="button">button</keyword> can be <property tag="hilite">highlighted</property> at once:  clicking another <keyword tag="button">button</keyword> unhighlights the first one. The <property tag="radioBehavior">radioBehavior</property> <glossary tag="property">property</glossary> of a <command tag="group">group</command> of <glossary tag="button">buttons</glossary> specifies whether they act as a <glossary tag="radio button">radio-button cluster</glossary>.</p><p/><p>The <b>hilitedButton</b>, <property tag="hilitedButtonName">hilitedButtonName</property>, and <property tag="hilitedButtonID">hilitedButtonID</property> <property tag="properties">properties</property> all refer in different ways to the same <keyword tag="button">button</keyword>. When any of them changes, all of them change.</p>
  </description>
</doc>