From RAD Studio API Documentation
Jump to: navigation, search


function IsCaptionLinked: Boolean; virtual;


virtual bool __fastcall IsCaptionLinked();


Type Visibility Source Unit Parent
function protected
System.Actions TContainedActionLink


Indicates whether or not the Caption property of the action and the Caption property of the client of the action link are linked.

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

  • When IsCaptionLinked returns True, the action link controls the Caption property; changes to the action's Caption property are reflected in the client object.
  • When IsCaptionLinked returns False, the client object is not influenced by the Caption property of its action, either because it does not have the Caption property, or because it manages the value of its Caption property independently.

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

See Also