System.Windows.Forms.HelpProvider.GetShowHelp Method

Returns a value indicating whether the specified control's Help should be displayed.

Syntax

[System.ComponentModel.Localizable(true)]
public virtual bool GetShowHelp (Control ctl)

Parameters

ctl
A System.Windows.Forms.Control for which Help will be displayed.

Returns

true if Help will be displayed for the control; otherwise, false.

Remarks

When you use the HelpProvider.SetHelpKeyword(Control, string) or HelpProvider.SetHelpString(Control, string) method to associate a keyword or prompt with a specified control, calling this method automatically returns true. You can override this behavior by passing false to the HelpProvider.SetShowHelp(Control, bool) method.

Requirements

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0