HelpProvider.getShowHelp

Overview | Methods | This Package | All Packages

HelpProvider.getShowHelp

Retrieves a boolean value that indicates whether help should be displayed for the specified control.

Syntax

public boolean getShowHelp( Control ctl )

Parameters

ctl

A Control object for which help should or should not be displayed.

Return Value

Returns true if help will be displayed for the control; otherwise, returns false.

Remarks

When you use the setHelpTopic or setHelpString method to associate a topic or prompt with a specified control, calling this method automatically returns true. You can override this behavior by passing false to the setShowHelp method.