This documentation is archived and is not being maintained.

HelpProvider.SetHelpKeyword Method

Specifies the keyword used to retrieve Help when the user invokes Help for the specified control.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public virtual void SetHelpKeyword (
	Control ctl,
	string keyword
)
public void SetHelpKeyword (
	Control ctl, 
	String keyword
)
public function SetHelpKeyword (
	ctl : Control, 
	keyword : String
)
Not applicable.

Parameters

ctl

A Control that specifies the control for which to set the Help topic.

keyword

The Help keyword to associate with the control.

The Help keyword provides the key information to retrieve the Help associated with this control from the Help file specified by the HelpNamespace property. To open Help to a specific topic, the keyword should be passed in the form topicName.htm. To clear the keyword, call the SetHelpKeyword method with a keyword value of a null reference (Nothing in Visual Basic).

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: