System.Actions.TContainedActionLink.IsImageIndexLinked

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IsImageIndexLinked: Boolean; virtual;

C++

virtual bool __fastcall IsImageIndexLinked();

Properties

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

Description

Retrieves whether the ImageIndex property for the action and for the client of the action link are linked.

TContainedActionLink descendants call IsImageIndexLinked to determine whether they need to propagate changes to the action's ImageIndex property to the corresponding ImageIndex property of the client object:

  • When IsImageIndexLinked returns True, the action controls the ImageIndex property; changes made to the action's ImageIndex property are reflected by changes to the corresponding property of the client object.
  • When IsImageIndexLinked returns False, the client object is not influenced by the ImageIndex 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, IsImageIndexLinked merely checks that the Action property specifies a descendant of TContainedAction (that is, it is an action that has an ImageIndex property), and if so, returns True. Descendant classes can override IsImageIndexLinked to determine whether the ImageIndex property is linked with the appropriate client property.

See Also