HelpProvider.GetShowHelp(Control) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: HelpProvider.cs

Source:: HelpProvider.cs

Source:: HelpProvider.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 virtual bool GetShowHelp(System::Windows::Forms::Control ^ ctl);

public virtual bool GetShowHelp (System.Windows.Forms.Control ctl);

abstract member GetShowHelp : System.Windows.Forms.Control -> bool
override this.GetShowHelp : System.Windows.Forms.Control -> bool

Public Overridable Function GetShowHelp (ctl As Control) As Boolean

Parameters

ctl: Control

A Control for which Help will be displayed.

Returns

Boolean

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

Remarks

When you use the SetHelpKeyword or SetHelpString 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 SetShowHelp method.

Applies to

Jaa