RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TActionLink.IsHelpLinked Method

Indicates whether the help properties for the action and client are linked.

Pascal
function IsHelpLinked: Boolean; virtual;
C++
virtual __fastcall Boolean IsHelpLinked();

TActionLink descendants call IsHelpLinked to determine whether they need to propagate changes to the HelpContext, HelpKeyword, and HelpType properties of the action so that they are reflected by client objects. When IsHelpLinked returns true, the action controls these properties: Changes to any of the help properties of the action are reflected by changes to the corresponding property of the client object. When IsHelpLinked returns false, the client object does not reflect the help properties 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 TActionLink, IsHelpLinked merely checks that the Action property specifies a descendant of TCustomAction (that is, it is an action that has HelpContext, HelpKeyword, and HelpType properties). Descendant classes override IsHelpLinked to determine whether these properties are linked with the appropriate client property. 

 

Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!