System.Actions.TContainedActionLink.IsHelpLinked

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function IsHelpLinked: Boolean; virtual;

C++ 

virtual bool __fastcall IsHelpLinked();

Properties

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

Description

Retrieves whether the Help properties for the action and for the client of the action link are linked.

TContainedActionLink descendants call IsHelpLinked to determine whether they need to propagate changes made to the action's HelpContext, HelpKeyword, and HelpType properties to the corresponding Help properties of the client object:

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

Descendant classes can override IsHelpLinked to determine whether the help properties are linked with the appropriate client properties. If a client linked by a descendant class object does not support the help properties, then IsHelpLinked always returns False.

See Also

Retrieved from "http://docwiki.embarcadero.com/Libraries/Rio/e/index.php?title=System.Actions.TContainedActionLink.IsHelpLinked&oldid=734776"