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

備註

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

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 說明檔互動。 [ 顯示說明索引 ] 按鈕會顯示 [說明] 檔案的 [ 索引] 索引卷 標。 [ 顯示說明 ] 按鈕會根據 [說明 導覽器 ] 清單中選取的值，顯示 [說明] 檔案中的內容。 [ 顯示關鍵字 ] 按鈕會根據 [ 關鍵字 ] 文字方塊中指定的關鍵字，顯示說明檔中的內容。

例如，若要依索引值顯示橢圓說明頁面，請在 [說明導覽器] 下拉式清單中選取 HelpNavigator.KeywordIndex 值，在 [參數] 文字方塊中輸入橢圓，然後按一下 [顯示說明] 按鈕。 若要依關鍵字顯示「使用筆刷繪製」說明主題，請在 [關鍵字] 文字方塊中輸入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);

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 系統上的檔案路徑格式。

編譯的說明檔提供頁面中的內容目錄、索引、搜尋和關鍵字連結。 您可以針對 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 ^ 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 值。

parameter

Object

包含主題識別項的字串。

例外狀況

ArgumentException

parameter 為整數。

範例

下列程式碼範例會顯示一個表單，其中包含三個按鈕，可用來與 mspaint.chm 說明檔互動。 [ 顯示說明索引 ] 按鈕會顯示 [說明] 檔案的 [ 索引] 索引卷 標。 [ 顯示說明 ] 按鈕會根據 [說明 導覽器 ] 清單中選取的值，顯示 [說明] 檔案中的內容。 [ 顯示關鍵字 ] 按鈕會根據 [ 關鍵字 ] 文字方塊中指定的關鍵字，顯示說明檔中的內容。

例如，若要依索引值顯示橢圓說明頁面，請在 [說明導覽器] 下拉式清單中選取 HelpNavigator.KeywordIndex 值，在 [參數] 文字方塊中輸入橢圓，然後按一下 [顯示說明] 按鈕。 若要依關鍵字顯示「使用筆刷繪製」說明主題，請在 [關鍵字] 文字方塊中輸入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

備註

自 url 變數的格式可以是 C：\path\sample.chm 或 /folder/file.htm。 如需路徑格式的詳細資訊，請參閱 Windows 系統上的檔案路徑格式。

編譯的說明檔會在頁面中提供目錄、索引、搜尋和關鍵字連結。 您可以使用 自 parameter 變數來提供 、 HelpNavigator.TopicId 、 HelpNavigator.KeywordIndex 或 HelpNavigator.AssociateIndex 命令的其他精簡。 HelpNavigator.Topic 如果引數中指定的 command 值為 、 HelpNavigator.Index 或 HelpNavigator.Find ，這個值應該是空字串 (「」，或 String.EmptyHelpNavigator.TableOfContents) 。 command如果引數參考 HelpNavigator.Topic 、 HelpNavigator.TopicId 、 HelpNavigator.KeywordIndex 或 HelpNavigator.AssociateIndex ，這個值應該是包含主題名稱的字串，或是要顯示之主題的關鍵字或數值識別碼。

另請參閱

• ShowHelpIndex(Control, String)