Help.ShowHelp メソッド

定義

ヘルプ ファイルの内容を表示します。Displays the contents of a Help file.

オーバーロード

ShowHelp(Control, String)

指定した URL のヘルプ ファイルの内容を表示します。Displays the contents of the Help file at the specified URL.

ShowHelp(Control, String, String)

指定した URL で検出された、特定のキーワードについてのヘルプ ファイルの内容を表示します。Displays the contents of the Help file found at the specified URL for a specific keyword.

ShowHelp(Control, String, HelpNavigator)

指定した URL で検出された、特定のトピックについてのヘルプ ファイルの内容を表示します。Displays the contents of the Help file found at the specified URL for a specific topic.

ShowHelp(Control, String, HelpNavigator, Object)

ユーザーが指定した URL に配置されているヘルプ ファイルの内容を表示します。Displays the contents of the Help file located at the URL supplied by the user.

ShowHelp(Control, String)

指定した URL のヘルプ ファイルの内容を表示します。Displays the contents of the Help file at the specified 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

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

url
String

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

次のコード例は、 ShowHelpメソッドを示しています。The following code example demonstrates the ShowHelp method. この例を実行するには、という名前Button1のボタンを含むフォームに次のコードを貼り付けます。To run this example, paste the following code into a form that contains a button named 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

注釈

引数は、、c:\path\sample.chm または /folder/file.htmの形式で指定できます。 ** urlThe url argument can be of the form C:\path\sample.chm or /folder/file.htm. パスの形式の詳細については、「 Windows システムでのファイルパス形式」を参照してください。For information on the format of paths, see File path formats on Windows systems.

セキュリティ

WebPermission
HTTP 要求を介して HTML ヘルプファイルにアクセスするために使用します。for accessing an HTML Help file through an HTTP request. 関連付けられた列挙型:ConnectAssociated enumeration: Connect

SecurityPermission
HTTP サーバーから提供されていない HTML ヘルプファイルにアクセスする場合。for accessing an HTML Help file not served from an HTTP server. 関連付けられた列挙型:UnmanagedCodeAssociated enumeration: UnmanagedCode

こちらもご覧ください

ShowHelp(Control, String, String)

指定した URL で検出された、特定のキーワードについてのヘルプ ファイルの内容を表示します。Displays the contents of the Help file found at the specified URL for a specific keyword.

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

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

url
String

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

keyword
String

表示するヘルプに関連するキーワード。The keyword to display Help for.

次のコード例では、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.

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

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

注釈

引数は、、c:\path\sample.chm または /folder/file.htmの形式で指定できます。 ** urlThe url argument can be of the form C:\path\sample.chm or /folder/file.htm. パスの形式の詳細については、「 Windows システムでのファイルパス形式」を参照してください。For information on the format of paths, see File path formats on Windows systems.

keywordnullの場合は、ヘルプファイルの目次が表示されます。If keyword is null, the table of contents for the Help file will be displayed.

セキュリティ

WebPermission
HTTP 要求を介して HTML ヘルプファイルにアクセスするために使用します。for accessing an HTML Help file through an HTTP request. 関連付けられた列挙型:ConnectAssociated enumeration: Connect

SecurityPermission
HTTP サーバーから提供されていない HTML ヘルプファイルにアクセスする場合。for accessing an HTML Help file not served from an HTTP server. 関連付けられた列挙型:UnmanagedCodeAssociated enumeration: UnmanagedCode

こちらもご覧ください

ShowHelp(Control, String, HelpNavigator)

指定した URL で検出された、特定のトピックについてのヘルプ ファイルの内容を表示します。Displays the contents of the Help file found at the specified URL for a specific topic.

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

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

url
String

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

navigator
HelpNavigator

HelpNavigator 値のいずれか。One of the HelpNavigator values.

次のコード例は、メソッドを使用ShowHelpして、インデックスページにヘルプファイルを開く方法を示しています。The following code example demonstrates how to use the ShowHelp method to open a Help file to its index page. この例を実行するには、という名前Button2のボタンを含むフォームに次のコードを貼り付けます。To run this example, paste the following code into a form that contains a button named 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

注釈

引数は、、c:\path\sample.chm または /folder/file.htmの形式で指定できます。 ** urlThe url argument can be of the form C:\path\sample.chm or /folder/file.htm. パスの形式の詳細については、「 Windows システムでのファイルパス形式」を参照してください。For information on the format of paths, see File path formats on Windows systems.

コンパイルされたヘルプファイルには、ページ内の目次、インデックス、検索、およびキーワードリンクが用意されています。Compiled Help files provide table of contents, index, search, and keyword links in pages. navigator HelpNavigator.Topic引数にはHelpNavigator.Find、、、 、またはの各値を使用できます。HelpNavigator.Index HelpNavigator.TableOfContentsYou can use the following values for the navigator argument: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Index, or HelpNavigator.Topic.

セキュリティ

WebPermission
HTTP 要求を介して HTML ヘルプファイルにアクセスするために使用します。for accessing an HTML Help file through an HTTP request. 関連付けられた列挙型:ConnectAssociated enumeration: Connect

SecurityPermission
HTTP サーバーから提供されていない HTML ヘルプファイルにアクセスする場合。for accessing an HTML Help file not served from an HTTP server. 関連付けられた列挙型:UnmanagedCodeAssociated enumeration: UnmanagedCode

こちらもご覧ください

ShowHelp(Control, String, HelpNavigator, Object)

ユーザーが指定した URL に配置されているヘルプ ファイルの内容を表示します。Displays the contents of the Help file located at the URL supplied by the user.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ param);
public static void ShowHelp (System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator command, object param);
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, param As Object)

パラメーター

parent
Control

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

url
String

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

command
HelpNavigator

HelpNavigator 値のいずれか。One of the HelpNavigator values.

parameter
Object

トピック識別子を格納する文字列。A string that contains the topic identifier.

例外

parameter が整数値です。parameter is an integer.

次のコード例では、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.

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

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

注釈

引数は、、c:\path\sample.chm または /folder/file.htmの形式で指定できます。 ** urlThe url argument can be of the form C:\path\sample.chm or /folder/file.htm. パスの形式の詳細については、「 Windows システムでのファイルパス形式」を参照してください。For information on the format of paths, see File path formats on Windows systems.

コンパイルされたヘルプファイルは、ページ内の目次、インデックス、検索、およびキーワードリンクを提供します。Compiled Help files provide table-of-contents, index, search, and keyword links in pages. parameter引数を使用してHelpNavigator.TopicHelpNavigator.TopicId、、、またはHelpNavigator.AssociateIndexコマンドをさらに改良することができます。 HelpNavigator.KeywordIndexYou can use the parameter argument to provide additional refinement of the HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndex, or HelpNavigator.AssociateIndex command. command引数に指定された値がHelpNavigator.TableOfContentsHelpNavigator.Index、またHelpNavigator.Findはの場合、この値は空の文字列 ("" String.Empty、または) である必要があります。If the value specified in the command argument is HelpNavigator.TableOfContents, HelpNavigator.Index, or HelpNavigator.Find, this value should be an empty string ("", or String.Empty). 引数がcommand HelpNavigator.TopicHelpNavigator.TopicId、、またはHelpNavigator.AssociateIndexを参照する場合、この値は、トピック名、または表示するトピックのキーワードまたは数値識別子を含む文字列である必要があります。 HelpNavigator.KeywordIndexIf the command argument references HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndex, or HelpNavigator.AssociateIndex, this value should be a string that contains the topic name, or the keyword or numeric identifier of the topic to display.

セキュリティ

WebPermission
HTTP 要求を介して HTML ヘルプファイルにアクセスするために使用します。for accessing an HTML Help file through an HTTP request. 関連付けられた列挙型:ConnectAssociated enumeration: Connect

SecurityPermission
HTTP サーバーから提供されていない HTML ヘルプファイルにアクセスする場合。for accessing an HTML Help file not served from an HTTP server. 関連付けられた列挙型:UnmanagedCodeAssociated enumeration: UnmanagedCode

こちらもご覧ください

適用対象