Vcl.StdActns.THelpOnHelp

From RAD Studio API Documentation
Jump to: navigation, search

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

Delphi

THelpOnHelp = class(THelpAction)

C++

class PASCALIMPLEMENTATION THelpOnHelp : public THelpAction

Properties

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

Description

THelpOnHelp brings up a help topic on how to use Help.

Add THelpOnHelp to an action list to allow users to bring up the help system that describes how to use help. Controls such as menu items and tool buttons linked to this action cause the application to send the default help system a command to display its help.

In order for THelpOnHelp 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.

Note: When you use the HTMLHelp help system, this function does not show a help file that describe the HTMLHelp help system.

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