Help.ShowHelpIndex メソッド

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

Help.ShowHelpIndex メソッド

指定したヘルプ ファイルの索引を表示します。

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

Visual Basic (宣言)

Public Shared Sub ShowHelpIndex
 ( _
    parent As Control, _
    url As String _
)

Visual Basic (使用法)

Dim parent As Control
Dim url As String

Help.ShowHelpIndex(parent, url)

C#

public static void ShowHelpIndex
 (
    Control parent,
    string url
)

C++

public:
static void ShowHelpIndex (
    Control^ parent, 
    String^ url
)

J#

public static void ShowHelpIndex
 (
    Control parent, 
    String url
)

JScript

public static function ShowHelpIndex
 (
    parent : Control, 
    url : String
)

パラメータ

parent

[ヘルプ] ダイアログ ボックスの親を識別する Control。

url

ヘルプ ファイルのパスと名前。

解説

url パラメータは、C:\path\sample.chm または /folder/file.htm の形式で指定できます。

使用例

mspaint.chm ヘルプ ファイルと対話するための 3 つのボタンが配置されたフォームを表示するコード例を次に示します。[Show Help Index] ボタンをクリックすると、このヘルプ ファイルの [Index] タブが表示されます。[Show Help] ボタンをクリックすると、[Help Navigator] リスト内で選択されている値に基づいて、ヘルプ ファイルの内容が表示されます。[Show Keyword] ボタンをクリックすると、[Keyword] ボックスで指定されているキーワードに基づいて、ヘルプ ファイルの内容が表示されます。

たとえば、インデックス値を使って Ovals ヘルプ ページを表示するには、[Help Navigator] ドロップダウン リストで HelpNavigator.KeywordIndex 値を選択し、[Parameter] ボックスに「ovals」と入力した後、[Show Help] ボタンをクリックします。"ブラシで描くには" ヘルプ トピックをキーワードを指定して表示するには、[Keyword] ボックスに「mspaint.chm::/paint_brush.htm」と入力し、[Show Keyword] ボタンをクリックします。

ShowHelpIndex メソッドの呼び出しの部分の例を次に示します。コード例全体については、Help クラスの概要を参照してください。

Visual Basic

Private Sub showIndex_Click(ByVal
 sender As Object, ByVal
 e As System.EventArgs) Handles showIndex.Click
    ' Display the index for the Help file.
    Help.ShowHelpIndex(Me, helpfile)
End Sub 'showIndex_Click

C#

private void showIndex_Click(object sender,
 System.EventArgs e)
{
    // Display the index for the help file.
    Help.ShowHelpIndex(this, helpfile);
}

C++

private:
   void showIndex_Click( Object^ /*sender*/, System::EventArgs^
 /*e*/ )
   {
      
      // Display the index for the help file.
      Help::ShowHelpIndex( this, helpfile );
   }

J#

private void showIndex_Click(Object sender,
 System.EventArgs e)
{
    // Display the index for the help file.
    Help.ShowHelpIndex(this, helpfile);
} //showIndex_Click

.NET Framework のセキュリティ

• WebPermission  (HTTP 要求によって HTML ヘルプ ファイルにアクセスするために必要な許可)。NetworkAccess.Connect (関連する列挙体)
• SecurityPermission  (HTTP サーバーによって提供されない HTML ヘルプ ファイルにアクセスするために必要な許可)。UnmanagedCode (関連する列挙体)

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Mobile for Pocket PC, 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

参照

関連項目
Help クラス
Help メンバ
System.Windows.Forms 名前空間
ShowHelp