This documentation is archived and is not being maintained.

HelpProvider.GetShowHelp Method

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public virtual bool GetShowHelp(
	Control ctl
)

Parameters

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

Return Value

Type: System.Boolean
true if Help will be displayed for the control; otherwise, false.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: