hilitedButtonID

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 hilitedButtonID of group to buttonID

# Examples

set the hilitedButtonID of group "Options" to 342

set the hilitedButtonID of group 1 to the short ID of the mouseControl

# Description

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

The hilitedButtonID specifies which button in a group is currently highlight. If the hilitedButtonID of a group is zero, none of the buttons in the group is currently highlight.

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

The hilitedButtonID 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:** radioBehavior, hilitedButton, hilitedButtonName, ID - **keyword:** button - **command:** hilite, group - **object:** button - **glossary:** property, highlight, radio button