Help.ShowHelpIndex(Control, String) メソッド

定義

指定したヘルプ ファイルの索引を表示します。Displays the index of the specified Help file.

public:
 static void ShowHelpIndex(System::Windows::Forms::Control ^ parent, System::String ^ url);
public static void ShowHelpIndex (System.Windows.Forms.Control parent, string url);
static member ShowHelpIndex : System.Windows.Forms.Control * string -> unit
Public Shared Sub ShowHelpIndex (parent As Control, url As String)

パラメーター

parent
Control

[ヘルプ] ダイアログ ボックスの親を識別する ControlA Control that identifies the parent of the Help dialog box.

url
String

ヘルプ ファイルのパスと名前。The path and name of the Help file.

次のコード例では、mspaint.exe ヘルプファイルを操作するために使用できる3つのボタンを持つフォームが表示されます。The following code example displays a form with three buttons that can be used to interact with the mspaint.chm Help file. [ ヘルプインデックスの表示 ] ボタンをクリックすると、ヘルプファイルの [ インデックス ] タブが表示されます。The Show Help Index button displays the Index tab for the Help file. [ヘルプの 表示 ] ボタンをクリックすると、ヘルプファイルの内容が [ ヘルプナビゲーター ] の一覧で選択した値に基づいて表示されます。The Show Help button displays content in the Help file based on the value that is selected in the Help Navigator list. [ キーワードの表示 ] ボタンをクリックすると、 キーワードテキストボックス で指定されたキーワードに基づいて、ヘルプファイルの内容が表示されます。The Show Keyword button displays content in the Help file based on the keyword that is specified in the Keyword text box.

たとえば、楕円のヘルプページをインデックス値で表示するには、[ HelpNavigator.KeywordIndex ヘルプナビゲーター ] ドロップダウンリストで値を選択し、[パラメーター ] ボックスに「楕円」と入力して、[ヘルプの表示] ボタンをクリックします。For example, to show the Ovals Help page by the index value, select the HelpNavigator.KeywordIndex value in the Help Navigator drop-down list, type ovals in the Parameter text box, and then click the Show Help button. キーワードを使用して "ブラシで塗りつぶす" ヘルプトピックを表示するには、[キーワード] ボックスに「 mspaint.exe::/paint_brush.htm 」と入力し、[キーワードの表示] ボタンをクリックします。To show the "To paint with a brush" Help topic by the keyword, type mspaint.chm::/paint_brush.htm in the Keyword text box, and then click the Show Keyword button.

この例は、メソッドの呼び出しのみを示して ShowHelpIndex います。This example shows only the call to the ShowHelpIndex method. 完全なコード例については、クラスの概要を参照してください HelpSee the Help class overview for the complete code example.

private:
   void showIndex_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      
      // Display the index for the help file.
      Help::ShowHelpIndex( this, helpfile );
   }
private void showIndex_Click(object sender, System.EventArgs e)
{
    // Display the index for the help file.
    Help.ShowHelpIndex(this, helpfile);
}
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

注釈

パラメーターには url 、、c:\path\sample.chm または/folder/file.htm の形式を使用できます。The url parameter can be of the form C:\path\sample.chm or /folder/file.htm.

適用対象

こちらもご覧ください