Name: hilitedButtonName

Type: property

Syntax: set the hilitedButtonName of <group> to <buttonName> 

Summary: Specifies which <button> in a <group> is currently <highlight|highlighted>.

Introduced: 1.0

OS: mac,windows,linux,ios,android

Platforms: desktop,server,web,mobile

Example:
set the hilitedButtonName of group "Options" to "Help"

Value: The <hilitedButtonName> of a <group> is the short <name> <property> of a <button>.

Description:
Use the <hilitedButtonName> <property> to change the current setting in a <radio button|radio-button cluster>.

The <hilitedButtonName> specifies which <button(keyword)> in a <group> is currently <highlight|highlighted>. If the <hilitedButtonName> of a <group> is empty, none of the <button(object)|buttons> in the <group> is currently <highlight|highlighted>.

Setting the <hilitedButtonName> of a <group> sets the <hilite> <property> of the rest of the <button(object)|buttons> to false.

The <hilitedButtonName> <property> is most useful in <radio button|radio-button clusters>. In a <radio button|radio-button cluster>, only one <button(keyword)> can be <highlight|highlighted> at once:  clicking another <button(keyword)> unhighlights the first one. The <radioBehavior> <property> of a <group> of <button(object)|buttons> specifies whether they act as a <radio button|radio-button cluster>.

The <hilitedButton>, <hilitedButtonName>, and <hilitedButtonID> <property|properties> all refer in different ways to the same <button(keyword)>. When any of them changes, all of them change.

References: family (property), hilite (property), hilitedButtonID (property), name (property), hilitedButton (property), autoHilite (property), radioBehavior (property), button (keyword), hilite (command), group (command), button (object), property (glossary), highlight (glossary), hilitedButtonID (glossary), radio button (glossary), radioBehavior (glossary)

Tags: ui
