Vcl.ActnMan.TActionClientLink.SetHelpContext

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure SetHelpContext(Value: THelpContext); override;

C++

virtual void __fastcall SetHelpContext(System::Classes::THelpContext Value);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
Vcl.ActnMan.pas
Vcl.ActnMan.hpp
Vcl.ActnMan TActionClientLink

Description

Introduces an interface for setting the integer Help context ID of a client.

Vcl.ActnMan.TActionClientLink.SetHelpContext inherits from System.Actions.TContainedActionLink.SetHelpContext. All content below this line refers to System.Actions.TContainedActionLink.SetHelpContext.

Introduces an interface for setting the integer Help context ID of a client.

Value specifies the new value of the HelpContext property of the action.

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

As implemented in TContainedActionLink, SetHelpContext does nothing. Descendant classes can override SetHelpContext to set the client's HelpContext property to be equal to the action's HelpContext property if the IsHelpLinked method returns True.

See Also