Help.ShowHelpIndex(Control, String) 方法

定义

显示指定帮助文件的索引。

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

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

url
String

帮助文件的路径和名称。

示例

下面的代码示例显示一个窗体,其中包含三个按钮,可用于与 mspaint.chm 帮助文件交互。 “ 显示帮助索引 ”按钮显示帮助文件的 “索引 ”选项卡。 “ 显示帮助 ”按钮根据 “帮助导航器 ”列表中选择的值显示帮助文件中的内容。 “ 显示关键字 ”按钮根据 关键字文本框中指定的 关键字显示帮助文件中的内容。

例如,若要按索引值显示椭圆帮助页,请在HelpNavigator.KeywordIndex“帮助导航器”下拉列表中选择值,在 “参数”文本框中键入 椭圆,然后单击“显示帮助”按钮。 若要按关键字显示“使用画笔绘制”帮助主题,请在 关键字文本框中键入 mspaint.chm::/paint_brush.htm,然后单击“显示关键字”按钮。

此示例仅显示对方法的 ShowHelpIndex 调用。 Help有关完整的代码示例,请参阅类概述。

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。

适用于

另请参阅