Help.ShowHelp 方法

参考

定义

命名空间:: System.Windows.Forms

程序集:: System.Windows.Forms.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

显示帮助文件的内容。

重载

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);

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

注解

参数 url 的格式可以是 C：\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);

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 帮助文件交互的三个按钮。 “ 显示帮助索引 ”按钮显示帮助文件的“ 索引 ”选项卡。 “ 显示帮助 ”按钮根据“帮助 导航器 ”列表中选择的值显示帮助文件中的内容。 “显示关键字”按钮根据“关键字”文本框中指定的关键字 (keyword) 显示帮助文件中的内容。

例如，若要按索引值显示“椭圆帮助”页，请在“帮助导航器”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

注解

参数 url 的格式可以是 C：\path\sample.chm 或 /folder/file.htm。有关路径格式的信息，请参阅 Windows 系统上的文件路径格式。

如果 keyword 为 null，将显示帮助文件的目录。

另请参阅

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);

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 值之一。

示例

下面的代码示例演示如何使用 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

注解

参数 url 的格式可以是 C：\path\sample.chm 或 /folder/file.htm。有关路径格式的信息，请参阅 Windows 系统上的文件路径格式。

编译的帮助文件在页面中提供目录、索引、搜索和关键字 (keyword) 链接。可以将以下值用于 navigator 参数： HelpNavigator.TableOfContents、 HelpNavigator.Find、 HelpNavigator.Index或 HelpNavigator.Topic。

另请参阅

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 ^ param);

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 param);

public static void ShowHelp (System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator command, 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

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)

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

参数

parent: Control

标识“帮助”对话框的父级的 Control。

url: String

帮助文件的路径和名称。

command: HelpNavigator

HelpNavigator 值之一。

paramparameter: Object

一个包含主题标识符的字符串。

例外

ArgumentException

parameter 为整数。

示例

此示例仅显示对方法的 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

注解

参数 url 的格式可以是 C：\path\sample.chm 或 /folder/file.htm。有关路径格式的信息，请参阅 Windows 系统上的文件路径格式。

编译的帮助文件在页面中提供目录、索引、搜索和关键字 (keyword) 链接。可以使用 parameter 参数提供对、HelpNavigator.TopicId、 HelpNavigator.KeywordIndex或 HelpNavigator.AssociateIndex 命令的其他HelpNavigator.Topic优化。如果参数中指定的command值为、或 HelpNavigator.Find，HelpNavigator.Index则此值应为空字符串 (“”或String.Empty HelpNavigator.TableOfContents) 。 command如果参数引用 HelpNavigator.Topic、HelpNavigator.TopicId、 HelpNavigator.KeywordIndex或 HelpNavigator.AssociateIndex，则此值应是包含主题名称或要显示的主题关键字 (keyword) 或数字标识符的字符串。

另请参阅

ShowHelpIndex(Control, String)

适用于

通过

Help.ShowHelp 方法

定义

重载

ShowHelp(Control, String)

参数

示例

注解

另请参阅

适用于

ShowHelp(Control, String, String)

参数

示例

注解

另请参阅

适用于

ShowHelp(Control, String, HelpNavigator)

参数

示例

注解

另请参阅

适用于

ShowHelp(Control, String, HelpNavigator, Object)

参数

例外

示例

注解

另请参阅

适用于

其他资源