HelpProvider.SetHelpKeyword メソッド

.NET Framework クラス ライブラリ リファレンス

HelpProvider.SetHelpKeyword メソッド

ユーザーが指定したコントロールのヘルプを呼び出すときに、ヘルプを検索するために使用するキーワードを指定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

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

instance.SetHelpKeyword(ctl, keyword)

C#

public virtual void SetHelpKeyword (
    Control ctl,
    string keyword
)

C++

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

J#

public void SetHelpKeyword (
    Control ctl, 
    String keyword
)

JScript

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

パラメータ

ctl

ヘルプ トピックの設定対象となるコントロールを指定する Control。

keyword

コントロールに関連付けるヘルプ キーワード。

解説

ヘルプ キーワードは、HelpNamespace プロパティによって指定されたヘルプ ファイルからこのコントロールに関連付けられているヘルプを検索するために、検索条件となる情報を提供します。ヘルプの特定のトピックを開くには、topicName.htm という形式でキーワードを指定する必要があります。キーワードを削除するには、keyword 値を null 参照 (Visual Basic では Nothing) に指定して、SetHelpKeyword メソッドを呼び出します。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
HelpProvider クラス
HelpProvider メンバ
System.Windows.Forms 名前空間
GetHelpString
GetHelpKeyword
GetShowHelp
SetHelpString
SetHelpKeyword