<doc>
  <legacy_id>1847</legacy_id>
  <name>hilite</name>
  <type>property</type>
  <syntax>
    <example>set the hilite of <i>button</i> to {true | false}</example>
  </syntax>
  <library></library>
  <objects>
    <button/>
  </objects>
  <synonyms>
    <synonym>highlight</synonym>
    <synonym>highlite</synonym>
    <synonym>hilight</synonym>
    <synonym>highlighted</synonym>
    <synonym>highlited</synonym>
    <synonym>hilighted</synonym>
    <synonym>hilited</synonym>
  </synonyms>
  <classification>
    <category>Appearance &amp; Positioning</category>
  </classification>
  <references>
    <command tag="hilite">hilite Command</command>
    <property tag="hilitedButtonName">hilitedButtonName Property</property>
    <property tag="hilitedIcon">hilitedIcon Property</property>
    <property tag="showHilite">showHilite Property</property>
    <property tag="hiliteFill">hiliteFill Property</property>
    <property tag="hiliteBorder">hiliteBorder 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>Determines whether a <keyword tag="button">button</keyword> is <property tag="hilite">highlighted</property>.</summary>
  <examples>
    <example>set the hilite of button "Option 1" to true</example>
    <example>set the hilite of me to not the hilite of me</example>
  </examples>
  <description>
    <p>Use the <b>hilite</b> <glossary tag="property">property</glossary> to provide visual feedback when a <keyword tag="button">button</keyword> is pressed, or to reflect the state of a setting.</p><p/><p><b>Value:</b></p><p>The <b>hilite</b> of a <keyword tag="button">button</keyword> is true or false.</p><p/><p>By default, the <b>hilite</b> <glossary tag="property">property</glossary> of a newly created <keyword tag="button">button</keyword> is set to false.</p><p/><p><b>Comments:</b></p><p>The effect of the <b>hilite</b> <glossary tag="property">property</glossary> on a <keyword tag="button">button</keyword> depends on the <property tag="style">style</property>, <property tag="threeD">threeD</property>, and <property tag="hiliteBorder">hiliteBorder</property> of the <keyword tag="button">button</keyword>.</p><p/><p>If the button's <b>hiliteBorder</b> and <property tag="threeD">threeD</property> <property tag="properties">properties</property> are true, the <property tag="topColor">topColor</property> and <property tag="bottomColor">bottomColor</property> (or <property tag="topPattern">topPattern</property> and <property tag="bottomPattern">bottomPattern</property>) are reversed when the <keyword tag="button">button</keyword> is <property tag="hilite">highlighted</property>.</p><p/><p>If a radio button's or checkbox's <b>hilite</b> is true, the <glossary tag="radio button">radio button</glossary> or <glossary tag="checkbox">checkbox</glossary> option is selected. If the <b>hilite</b> is false, the option is not selected.</p><p/><p>For buttons of any other style, if the <b>hilite</b> is true, the <glossary tag="button">button's</glossary> background is drawn in the <property tag="hiliteColor">hiliteColor</property> (or the <property tag="hilitePattern">hilitePattern</property>, if the <glossary tag="button">button's</glossary> <property tag="hiliteFill">hiliteFill</property> <glossary tag="property">property</glossary> is true).</p>
  </description>
</doc>