Help.ShowHelp メソッド

定義

名前空間:

System.Windows.Forms

アセンブリ:

System.Windows.Forms.dll

ヘルプ ファイルの内容を表示します。

オーバーロード

ShowHelp(Control, String)	指定した URL のヘルプ ファイルの内容を表示します。
ShowHelp(Control, String, String)	指定した URL で検出された、特定のキーワードについてのヘルプ ファイルの内容を表示します。
ShowHelp(Control, String, HelpNavigator)	指定した URL で検出された、特定のトピックについてのヘルプ ファイルの内容を表示します。
ShowHelp(Control, String, HelpNavigator, Object)	ユーザーが指定した URL に配置されているヘルプ ファイルの内容を表示します。

ShowHelp(Control, String)

指定した URL のヘルプ ファイルの内容を表示します。

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url);

static member ShowHelp : System.Windows.Forms.Control * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String)

パラメーター

parent

Control

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

url

String

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

例

次のコード例は、 メソッドを ShowHelp 示しています。 この例を実行するには、 という名前 Button1のボタンを含むフォームに次のコードを貼り付けます。

// Open the Help file for the Character Map topic.  
void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm" );
}

// Open the Help file for the Character Map topic.  
private void Button1_Click(System.Object sender, System.EventArgs e)
{

    Help.ShowHelp(TextBox1, "file://c:\\charmap.chm");
}

' Open the Help file for the Character Map topic.  
Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm")
End Sub

注釈

引数の形式は urlC:\path\sample.chm または /folder/file.htmです。 パスの形式については、「 Windows システムのファイル パス形式」を参照してください。

こちらもご覧ください

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

指定した URL で検出された、特定のキーワードについてのヘルプ ファイルの内容を表示します。

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::String ^ keyword);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, string? keyword);

static member ShowHelp : System.Windows.Forms.Control * string * string -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, keyword As String)

パラメーター

parent

Control

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

url

String

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

keyword

String

表示するヘルプに関連するキーワード。

例

次のコード例では、mspaint.chm ヘルプ ファイルを操作するために使用できる 3 つのボタンを含むフォームを表示します。 [ ヘルプ インデックスの表示 ] ボタンには、ヘルプ ファイルの [ インデックス ] タブが表示されます。 [ ヘルプの表示 ] ボタンは、[ヘルプ ナビゲーター] リストで選択されている値に基づいて ヘルプ ファイル内のコンテンツを表示します。 [キーワードの表示] ボタンは、[キーワード] テキスト ボックスで指定されたキーワード (keyword)に基づいてヘルプ ファイル内のコンテンツを表示します。

たとえば、[Ovals ヘルプ] ページをインデックス値で表示するには、[ヘルプ ナビゲーター] ドロップダウン リストで値を選択HelpNavigator.KeywordIndexし、[パラメーター] テキスト ボックスに「楕円」と入力し、[ヘルプの表示] ボタンをクリックします。 キーワード (keyword)で [ブラシで塗りつぶすには] ヘルプ トピックを表示するには、[キーワード] テキスト ボックスに「mspaint.chm::/paint_brush.htm」と入力し、[キーワードの表示] ボタンをクリックします。

この例では、 メソッドの ShowHelp 呼び出しのみを示します。 完全な Help コード例については、クラスの概要を参照してください。

void showKeyword_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Display help using the provided keyword.
   Help::ShowHelp( this, helpfile, keyword->Text );
}

private void showKeyword_Click(object sender, System.EventArgs e)
{
    // Display help using the provided keyword.
    Help.ShowHelp(this, helpfile, keyword.Text);
}

Private Sub showKeyword_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showKeyword.Click
    ' Display Help using the provided keyword. 
    Help.ShowHelp(Me, helpfile, keyword.Text)
End Sub

注釈

引数の形式は urlC:\path\sample.chm または /folder/file.htmです。 パスの形式については、「 Windows システムのファイル パス形式」を参照してください。

が nullの場合keyword、ヘルプ ファイルの目次が表示されます。

こちらもご覧ください

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

指定した URL で検出された、特定のトピックについてのヘルプ ファイルの内容を表示します。

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator navigator);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator navigator);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, navigator As HelpNavigator)

パラメーター

parent

Control

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

url

String

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

navigator

HelpNavigator

HelpNavigator 値のいずれか 1 つ。

例

次のコード例では、 メソッドを使用 ShowHelp して、インデックス ページにヘルプ ファイルを開く方法を示します。 この例を実行するには、 という名前 Button2のボタンを含むフォームに次のコードを貼り付けます。

// Open the Help file for the Character Map topic and 
// display the Index page.
void Button2_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   Help::ShowHelp( TextBox1, "file://c:\\charmap.chm", HelpNavigator::Index );
}

// Open the Help file for the Character Map topic and 
// display the Index page.
private void Button2_Click(System.Object sender, System.EventArgs e)
{

    Help.ShowHelp(TextBox1, "file://c:\\charmap.chm", 
        HelpNavigator.Index);
}

' Open the Help file for the Character Map topic and 
' display the Index page.
Private Sub Button2_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button2.Click

    Help.ShowHelp(TextBox1, "file://c:\charmap.chm", HelpNavigator.Index)
End Sub

注釈

引数の形式は urlC:\path\sample.chm または /folder/file.htmです。 パスの形式については、「 Windows システムのファイル パス形式」を参照してください。

コンパイル済みヘルプ ファイルは、目次、インデックス、検索、ページ内のキーワード (keyword)リンクを提供します。 引数HelpNavigator.TableOfContentsには、、HelpNavigator.FindHelpNavigator.Indexまたは HelpNavigator.Topicの値をnavigator使用できます。

こちらもご覧ください

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

ユーザーが指定した URL に配置されているヘルプ ファイルの内容を表示します。

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ parameter);

public static void ShowHelp (System.Windows.Forms.Control? parent, string? url, System.Windows.Forms.HelpNavigator command, object? parameter);

static member ShowHelp : System.Windows.Forms.Control * string * System.Windows.Forms.HelpNavigator * obj -> unit

Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, parameter As Object)

パラメーター

parent

Control

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

url

String

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

command

HelpNavigator

HelpNavigator 値のいずれか 1 つ。

parameter

Object

トピック識別子を格納する文字列。

例外

ArgumentException

parameter が整数値です。

例

次のコード例では、mspaint.chm ヘルプ ファイルを操作するために使用できる 3 つのボタンを含むフォームを表示します。 [ ヘルプ インデックスの表示 ] ボタンには、ヘルプ ファイルの [ インデックス ] タブが表示されます。 [ ヘルプの表示 ] ボタンは、[ヘルプ ナビゲーター] リストで選択されている値に基づいて ヘルプ ファイル内のコンテンツを表示します。 [キーワードの表示] ボタンは、[キーワード] テキスト ボックスで指定されたキーワード (keyword)に基づいてヘルプ ファイル内のコンテンツを表示します。

たとえば、[Ovals ヘルプ] ページをインデックス値で表示するには、[ヘルプ ナビゲーター] ドロップダウン リストで値を選択HelpNavigator.KeywordIndexし、[パラメーター] テキスト ボックスに「楕円」と入力し、[ヘルプの表示] ボタンをクリックします。 キーワード (keyword)で [ブラシで塗りつぶすには] ヘルプ トピックを表示するには、[キーワード] テキスト ボックスに「mspaint.chm::/paint_brush.htm」と入力し、[キーワードの表示] ボタンをクリックします。

この例では、 メソッドの ShowHelp 呼び出しのみを示します。 完全な Help コード例については、クラスの概要を参照してください。

void showHelp_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   
   // Display Help using the Help navigator enumeration
   // that is selected in the combo box. Some enumeration
   // values make use of an extra parameter, which can
   // be passed in through the Parameter text box.
   HelpNavigator navigator = HelpNavigator::TableOfContents;
   if ( navigatorCombo->SelectedItem != nullptr )
   {
      navigator =  *safe_cast<HelpNavigator^>(navigatorCombo->SelectedItem);
   }

   Help::ShowHelp( this, helpfile, navigator, parameterTextBox->Text );
}

private void showHelp_Click(object sender, System.EventArgs e)
{
    // Display Help using the Help navigator enumeration
    // that is selected in the combo box. Some enumeration
    // values make use of an extra parameter, which can
    // be passed in through the Parameter text box.
    HelpNavigator navigator = HelpNavigator.TableOfContents;
    if (navigatorCombo.SelectedItem != null)
    {
        navigator = (HelpNavigator)navigatorCombo.SelectedItem;
    }
    Help.ShowHelp(this, helpfile, navigator, parameterTextBox.Text);
}

Private Sub showHelp_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showHelp.Click
    ' Display Help using the Help navigator enumeration
    ' that is selected in the combo box. Some enumeration
    ' values make use of an extra parameter, which can
    ' be passed in through the Parameter text box.
    Dim navigator As HelpNavigator = HelpNavigator.TableOfContents
    If (navigatorCombo.SelectedItem IsNot Nothing) Then
        navigator = CType(navigatorCombo.SelectedItem, HelpNavigator)
    End If
    Help.ShowHelp(Me, helpfile, navigator, parameterTextBox.Text)
End Sub

注釈

引数の形式は urlC:\path\sample.chm または /folder/file.htmです。 パスの形式については、「 Windows システムのファイル パス形式」を参照してください。

コンパイル済みヘルプ ファイルは、目次、インデックス、検索、ページ内のキーワード (keyword)リンクを提供します。 引数をparameter使用すると、、HelpNavigator.TopicId、HelpNavigator.KeywordIndex、または HelpNavigator.AssociateIndex コマンドをさらにHelpNavigator.Topic絞り込むことができます。 引数でcommand指定された値が 、、HelpNavigator.Indexまたは HelpNavigator.Findの場合、HelpNavigator.TableOfContentsこの値は空の文字列 (""、または String.Empty) である必要があります。 引数が command 、HelpNavigator.TopicIdHelpNavigator.KeywordIndexまたは HelpNavigator.AssociateIndexを参照HelpNavigator.Topicする場合、この値は、トピック名を含む文字列、または表示するトピックのキーワード (keyword)または数値識別子である必要があります。

こちらもご覧ください

• ShowHelpIndex(Control, String)