Methods | This Package | All Packages

HelpProvider Class

Defines methods that provide online help support for WFC controls.

Component
  |
  +--HelpProvider

package com.ms.wfc.ui

public class HelpProvider
extends Component
implements IExtenderProvider

Remarks

The HelpProvider class enables you to provide pop-up or full online help support for WFC controls.

To associate a help file (either HTML Help or WinHelp) with the HelpProvider object, use the setHelpFile method. To associate topics within the specified file with specific controls, make successive calls to the setHelpTopic method. The help that you specify for this method typically becomes available to the user when the user clicks the question mark icon that appears in the caption bar of a dialog box.

Optionally, to associate a specific help string with a control, use the setHelpString method. The string that you associate with a control using this method is displayed in a pop-up window when the user presses the F1 key while the control has input focus.