System.Actions.TContainedActionLink.IsEnabledLinked

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IsEnabledLinked: Boolean; virtual;

C++

virtual bool __fastcall IsEnabledLinked(void);

Properties

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

Description

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

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

  • When IsEnabledLinked returns True, the action controls the Enabled property; changes to the action's Enabled property are reflected by changes to the corresponding property of the client object.
  • When IsEnabledLinked returns False, the client object is not influenced by the Enabled 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, IsEnabledLinked merely checks that the Action property specifies a descendant of TContainedAction (that is, it is an action that has an Enabled property), and if so, returns True.

Descendant classes can override IsEnabledLinked to determine whether the Enabled property is linked with the appropriate client property. If a client linked by a descendant class object does not support the Enabled property, then IsEnabledLinked always returns False.

See Also