RAD Studio
ContentsIndex
PreviousUpNext
Registering Help System Objects

For the Help Manager to communicate with them, objects that implement ICustomHelpViewer, IExtendedHelpViewer, ISpecialWinHelpViewer, and IHelpSelector must register with the Help Manager. 

To register Help system objects with the Help Manager, you need to:

  • Register the Help viewer.
  • Register the Help Selector.

The unit that contains the object implementation must use HelpIntfs. An instance of the object must be declared in the var section of the implementing unit. 

The initialization section of the implementing unit must assign the instance variable and pass it to the function RegisterViewer. RegisterViewer is a flat function exported by the HelpIntfs unit, which takes as an argument an ICustomHelpViewer and returns an IHelpManager. The IHelpManager should be stored for future use.

The unit that contains the object implementation must use Forms in the VCL. An instance of the object must be declared in the var section of the implementing unit. 

The initialization section of the implementing unit must register the Help selector through the HelpSystem property of the global Application object:

Application.HelpSystem.AssignHelpSelector(myHelpSelectorInstance)

 

Application->HelpSystem->AssignHelpSelector(myHelpSelectorInstance)

This procedure does not return a value.

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!