hilite

Determines whether a button is highlight.

# Metadata

Platforms: desktop, server, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:

# Syntax

set the hilite of button to {true | false}

# Examples

set the hilite of button "Option 1" to true

set the hilite of me to not the hilite of me

# Description

Use the hilite property to provide visual feedback when a button is pressed, or to reflect the state of a setting.

The effect of the hilite property on a button depends on the style, threeD, and hiliteBorder of the button.

If the button's hiliteBorder and threeD property are true, the topColor and bottomColor (or topPattern and bottomPattern) are reversed when the button is highlight.

If a radio button's or checkbox's hilite is true, the radio button or checkbox option is selected. If the hilite is false, the option is not selected.

For buttons of any other style, if the hilite is true, the button background is drawn in the hiliteColor (or the hilitePattern, if the button hiliteFill property is true).

# Tags

ui,

# See

- **keyword:** button - **property:** bottomColor, showHilite, hiliteBorder, hilitedIcon, hiliteFill, hilitedButtonName, hiliteColor, hiliteBorder, bottomPattern, style, threeD, topColor, topPattern - **command:** hilite - **object:** button - **glossary:** property, highlight, checkbox, hilitePattern, radio button