Vcl.Buttons.TSpeedButtonActionLink.IsCheckedLinked

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IsCheckedLinked: Boolean; override;

C++

virtual bool __fastcall IsCheckedLinked(void);

Properties

Type Visibility Source Unit Parent
function protected
Vcl.Buttons.pas
Vcl.Buttons.hpp
Vcl.Buttons TSpeedButtonActionLink

Description

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

Vcl.Buttons.TSpeedButtonActionLink.IsCheckedLinked inherits from System.Actions.TContainedActionLink.IsCheckedLinked. All content below this line refers to System.Actions.TContainedActionLink.IsCheckedLinked.

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

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

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

Descendant classes can override IsCheckedLinked to determine whether the Checked property is linked with the appropriate client property. If a client (like FMX.Forms.TForm) linked by a descendant class object does not support the Checked property, then IsCheckedLinked always returns False.

See Also