System.Actions.TContainedActionLink.SetGroupIndex

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure SetGroupIndex(Value: Integer); virtual;

C++

virtual void __fastcall SetGroupIndex(int Value);

Properties

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

Description

Introduces an interface for setting the GroupIndex property for a client of the action link.

Value specifies the new value of the GroupIndex property.

The associated action calls SetGroupIndex when its GroupIndex property changes so that the action link can propagate the new Value to the GroupIndex property of the client object of the action link.

As implemented in TContainedActionLink, SetGroupIndex does nothing. Descendant classes override SetGroupIndex to set the client's GroupIndex property if the IsGroupIndexLinked method returns True.

Note: An action itself implements unchecking actions having the same GroupIndex value in the same action list. That is, when the value of the action's Checked property changes to True, the Checked property of all other actions in the action list having the same GroupIndex value become False.

See Also