Vcl.StdActns.THelpContextAction

From RAD Studio API Documentation
Jump to: navigation, search

Vcl.StdActns.THelpActionVcl.ActnList.TActionVcl.ActnList.TCustomActionSystem.Actions.TContainedActionSystem.Classes.TBasicActionSystem.Classes.TComponentSystem.Classes.TPersistentTHelpContextAction

Delphi

THelpContextAction = class(THelpAction)

C++

class PASCALIMPLEMENTATION THelpContextAction : public THelpAction

Properties

Type Visibility Source Unit Parent
class public
Vcl.StdActns.pas
Vcl.StdActns.hpp
Vcl.StdActns Vcl.StdActns

Description

THelpContextAction brings up the help topic for the active control.

Add THelpContextAction to an action list to allow users to bring up the help for an active control. Controls such as menu items and tool buttons linked to this action cause the application to send the help engine a command to display the help topic specified by the active control's Vcl.Controls.TControl.HelpContext property.

In order for THelpContextAction to work and to call the proper native Help handling function, insert in the uses clause of your application the Vcl.HtmlHelpViewer unit or other unit providing interface to the external Help viewer to use. The Vcl.HtmlHelpViewer unit provides a Delphi interface to the HTMLHelp Windows native Help handling function. For C++, you need to include the HTMLHelpViewer.hpp header files.

For information about the native Help handling functions HTMLHelp or other and about the data passed to them, see the appropriate HTMLHelp topics in the MSDN Library.

See Also