System.Actions.TContainedActionLink.IsGroupIndexLinked
Delphi
function IsGroupIndexLinked: Boolean; virtual;
C++
virtual bool __fastcall IsGroupIndexLinked(void);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | protected | System.Actions.pas System.Actions.hpp |
System.Actions | TContainedActionLink |
Description
Retrieves whether the GroupIndex property for the action and for the client of the action link are linked.
TContainedActionLink descendants can call IsGroupIndexLinked to determine whether they need to propagate changes made to the action's GroupIndex property to the corresponding GroupIndex property of the client object:
- When IsGroupIndexLinked returns True, the action link controls the GroupIndex property; changes made to the action's GroupIndex property are reflected by changes to the corresponding property of the client object.
- When IsGroupIndexLinked returns False, the client object is not influenced by the GroupIndex property of its action, either because it does not have a corresponding property, or, more commonly, because it manages the value of its corresponding property independently.
As implemented in TContainedActionLink, IsGroupIndexLinked merely checks that the Action property specifies a descendant of TContainedAction (that is, it is an action that has an GroupIndex property), and if so, returns True.
Descendant classes can override IsGroupIndexLinked to determine whether the GroupIndex property is linked with the appropriate client property. If a client linked by a descendant class object (like FMX.Forms.TForm) does not support the GroupIndex property, then IsGroupIndexLinked always returns False.
As implemented in TActionLink:
- IsGroupIndexLinked returns
Falseif the action, assigned to the action link, belongs to TCustomViewAction and the component of this action equals the client of the action link.
- Also IsGroupIndexLinked returns
Falseif the client does not support the GroupIndex property.
- Otherwise, IsGroupIndexLinked returns
True.