System.Actions.TContainedActionLink.IsStatusActionLinked

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IsStatusActionLinked: Boolean; virtual;

C++

virtual bool __fastcall IsStatusActionLinked();

Properties

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

Description

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

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

  • When IsStatusActionLinked returns True, the action controls the StatusAction property; changes made to the action's StatusAction property are reflected by changes to the corresponding property of the client object.
  • When IsStatusActionLinked returns False, the client object does not reflect the StatusAction property of its action, either because it does not have a corresponding property, or, more commonly, because it manages the value of this property independently.

As implemented in TContainedActionLink, IsStatusActionLinked merely checks that the Action property specifies a descendant of TContainedAction (that is, it is an action that has a StatusAction property), and if so, returns True. Descendant classes can override IsStatusActionLinked to determine whether the StatusAction property is linked with the appropriate client property.

See Also