FMX.Controls.TControlActionLink.SetHelpKeyword

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure SetHelpKeyword(const Value: string); override;

C++

virtual void __fastcall SetHelpKeyword(const System::UnicodeString Value);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
FMX.Controls.pas
FMX.Controls.hpp
FMX.Controls TControlActionLink

Description

Introduces an interface for setting the Help keyword of a client.

FMX.Controls.TControlActionLink.SetHelpKeyword inherits from System.Actions.TContainedActionLink.SetHelpKeyword. All content below this line refers to System.Actions.TContainedActionLink.SetHelpKeyword.

Introduces an interface for setting the Help keyword of a client.

Value specifies the new value of the HelpKeyword property.

The action link object calls SetHelpKeyword when the HelpKeyword property of the associated action changes so that the action link can propagate the new Value to the HelpKeyword property of the client object.

As implemented in TContainedActionLink, SetHelpKeyword does nothing. Descendant classes can override SetHelpKeyword to set the client property that corresponds to the action's HelpKeyword property if the IsHelpLinked method returns True.

See Also