HelpProvider.SetHelpKeyword Method (System.Windows.Forms)

SetHelpKeyword Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

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)

Syntax

Visual Basic (Declaration)

Public Overridable Sub SetHelpKeyword ( _
    ctl As Control, _
    keyword As String _
)

Visual Basic (Usage)

Dim instance As HelpProvider
Dim ctl As Control
Dim keyword As String

instance.SetHelpKeyword(ctl, keyword)

public virtual void SetHelpKeyword(
    Control ctl,
    string keyword
)

Visual C++

public:
virtual void SetHelpKeyword(
    Control^ ctl, 
    String^ keyword
)

JScript

public function SetHelpKeyword(
    ctl : Control, 
    keyword : String
)

Parameters

ctl: Type: System.Windows.Forms..::.Control
A Control that specifies the control for which to set the Help topic.

keyword: Type: System..::.String
The Help keyword to associate with the control.

Remarks

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 nullNothingnullptra null reference (Nothing in Visual Basic).

Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information