hilitedButton

Specifies which button in a group is currently highlight.

# Metadata

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

# Syntax

set the hilitedButton of group to buttonNumber

# Examples

set the hilitedButton of group "Options" to 2 -- 2nd button in group

set the hilitedButton of group ID 8 to zero -- unhilites all buttons

# Description

Use the hilitedButton property to change the current setting in a radio button.

The hilitedButton specifies which button in a group is currently highlight. If the hilitedButton of a group is zero, none of the buttons in the group is currently highlight. If the hilitedButton is 1, the button with the lowest layer in the group is currently highlight; if the hilitedButton is 2, the button with the second-lowest layer is currently highlight; and so forth.

Setting the hilitedButton of a group sets the hilite property of the rest of the buttons to false.

The hilitedButton property is most useful in radio button. In a radio button, only one button can be highlight at once: clicking another button unhighlights the first one. The radioBehavior property of a group of buttons specifies whether they act as a radio button.

The hilitedButton, hilitedButtonName, and hilitedButtonID property all refer in different ways to the same button. When any of them changes, all of them change.

# Tags

ui,

# See

- **property:** hilitedButtonName, radioBehavior, hilitedButtonName, hilitedButtonID - **keyword:** integer, button - **command:** hilite, group - **function:** selectedButton - **glossary:** property, highlight, radio button, layer - **object:** button