System.Actions.TContainedAction.SetGroupIndex

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure SetGroupIndex(const Value: Integer); virtual;

C++

virtual void __fastcall SetGroupIndex(const int Value);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
System.Actions.pas
System.Actions.hpp
System.Actions TContainedAction

Description

Sets the specified Value to the GroupIndex property of the action and properly handles the ON or OFF state of the Checked properties of all actions in the group specified by Value.

SetGroupIndex sets the specified Value to the GroupIndex property of the action. If the Checked property of this action is True, then SetGroupIndex sets the Checked property to False for all the other actions in the group defined by the specified Value.

When Value is greater than 0, the group of actions with the GroupIndex property having this Value forms a group of actions that act like a group of radio buttons. When the Checked property of any action in this group is True, the Checked properties of all other actions in the group are False. That is, one and only one action in the group is checked ON at a time.

Note: All actions in a group must be listed by the same action list.

See Also