Help.ShowHelp Metoda

Definice

Obor názvů:

System.Windows.Forms

Sestavení:

System.Windows.Forms.dll

Zobrazí obsah souboru nápovědy.

Přetížení

Name	Description
ShowHelp(Control, String)	Zobrazí obsah souboru nápovědy na zadané adrese URL.
ShowHelp(Control, String, String)	Zobrazí obsah souboru nápovědy nalezeného na zadané adrese URL pro konkrétní klíčové slovo.
ShowHelp(Control, String, HelpNavigator)	Zobrazí obsah souboru nápovědy nalezeného na zadané adrese URL konkrétního tématu.
ShowHelp(Control, String, HelpNavigator, Object)	Zobrazí obsah souboru nápovědy umístěného na adrese URL zadané uživatelem.

ShowHelp(Control, String)

Zdroj:

Help.cs

Zobrazí obsah souboru nápovědy na zadané adrese 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)

Parametry

parent

Control

A Control , která identifikuje nadřazenou položku dialogového okna Nápověda.

url

String

Cesta a název souboru nápovědy.

Příklady

Následující příklad kódu ukazuje metodu ShowHelp . Pokud chcete tento příklad spustit, vložte následující kód do formuláře, který obsahuje tlačítko s názvem 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

Poznámky

Argumentem url může být formát C:\path\sample.chm nebo /folder/file.htm. Informace o formátu cest najdete v tématu Souborové formáty cest v systémech Windows.

Viz také

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Zdroj:

Help.cs

Zobrazí obsah souboru nápovědy nalezeného na zadané adrese URL pro konkrétní klíčové slovo.

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)

Parametry

parent

Control

A Control , která identifikuje nadřazenou položku dialogového okna Nápověda.

url

String

Cesta a název souboru nápovědy.

keyword

String

Klíčové slovo pro zobrazení nápovědy.

Příklady

Následující příklad kódu zobrazí formulář se třemi tlačítky, které lze použít k interakci se souborem nápovědy mspaint.chm. Tlačítko Zobrazit index nápovědy zobrazí kartu Index pro soubor nápovědy. Tlačítko Zobrazit nápovědu zobrazuje obsah v souboru nápovědy na základě hodnoty vybrané v seznamu Navigátor nápovědy . Tlačítko Zobrazit klíčové slovo zobrazí obsah v souboru nápovědy na základě klíčového slova zadaného v textovém poli Klíčové slovo .

Chcete-li například zobrazit stránku nápovědy Ovals podle hodnoty indexu, vyberte HelpNavigator.KeywordIndex hodnotu v rozevíracím seznamu Navigátor nápovědy , zadejte ovály do textového pole Parametr a klikněte na tlačítko Zobrazit nápovědu . Chcete-li zobrazit téma nápovědy "Malování pomocí štětce" podle klíčového slova, zadejte mspaint.chm::/paint_brush.htm do textového pole Klíčové slovo a potom klikněte na tlačítko Zobrazit klíčové slovo .

Tento příklad ukazuje pouze volání ShowHelp metody. Kompletní příklad kódu najdete v přehledu Help třídy.

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

Poznámky

Argumentem url může být formát C:\path\sample.chm nebo /folder/file.htm. Informace o formátu cest najdete v tématu Souborové formáty cest v systémech Windows.

Pokud keyword ano null, zobrazí se obsah souboru nápovědy.

Viz také

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Zdroj:

Help.cs

Zobrazí obsah souboru nápovědy nalezeného na zadané adrese URL konkrétního tématu.

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)

Parametry

parent

Control

A Control , která identifikuje nadřazenou položku dialogového okna Nápověda.

url

String

Cesta a název souboru nápovědy.

navigator

HelpNavigator

Jedna z HelpNavigator hodnot.

Příklady

Následující příklad kódu ukazuje, jak použít metodu ShowHelp k otevření souboru nápovědy na jeho indexové stránce. Pokud chcete tento příklad spustit, vložte následující kód do formuláře, který obsahuje tlačítko s názvem 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

Poznámky

Argumentem url může být formát C:\path\sample.chm nebo /folder/file.htm. Informace o formátu cest najdete v tématu Souborové formáty cest v systémech Windows.

Kompilované soubory nápovědy poskytují obsah, index, vyhledávání a odkazy na klíčová slova na stránkách. Pro argument můžete použít následující hodnoty navigator : HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexnebo HelpNavigator.Topic.

Viz také

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

Zdroj:

Help.cs

Zobrazí obsah souboru nápovědy umístěného na adrese URL zadané uživatelem.

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)

Parametry

parent

Control

A Control , která identifikuje nadřazenou položku dialogového okna Nápověda.

url

String

Cesta a název souboru nápovědy.

command

HelpNavigator

Jedna z HelpNavigator hodnot.

parameter

Object

Řetězec, který obsahuje identifikátor tématu.

Výjimky

ArgumentException

parameter je celé číslo.

Příklady

Následující příklad kódu zobrazí formulář se třemi tlačítky, které lze použít k interakci se souborem nápovědy mspaint.chm. Tlačítko Zobrazit index nápovědy zobrazí kartu Index pro soubor nápovědy. Tlačítko Zobrazit nápovědu zobrazuje obsah v souboru nápovědy na základě hodnoty vybrané v seznamu Navigátor nápovědy . Tlačítko Zobrazit klíčové slovo zobrazí obsah v souboru nápovědy na základě klíčového slova zadaného v textovém poli Klíčové slovo .

Chcete-li například zobrazit stránku nápovědy Ovals podle hodnoty indexu, vyberte HelpNavigator.KeywordIndex hodnotu v rozevíracím seznamu Navigátor nápovědy , zadejte ovály do textového pole Parametr a klikněte na tlačítko Zobrazit nápovědu . Chcete-li zobrazit téma nápovědy "Malování pomocí štětce" podle klíčového slova, zadejte mspaint.chm::/paint_brush.htm do textového pole Klíčové slovo a potom klikněte na tlačítko Zobrazit klíčové slovo .

Tento příklad ukazuje pouze volání ShowHelp metody. Kompletní příklad kódu najdete v přehledu Help třídy.

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

Poznámky

Argumentem url může být formát C:\path\sample.chm nebo /folder/file.htm. Informace o formátu cest najdete v tématu Souborové formáty cest v systémech Windows.

Kompilované soubory nápovědy poskytují odkazy na obsah, index, vyhledávání a klíčová slova na stránkách. Argument můžete použít parameter k poskytnutí dalšího HelpNavigator.Topicupřesnění příkazu , HelpNavigator.TopicId, HelpNavigator.KeywordIndex, nebo HelpNavigator.AssociateIndex příkazu. Pokud je hodnota zadaná v argumentu command , HelpNavigator.TableOfContentsnebo HelpNavigator.Index, tato hodnota by měla být prázdný řetězec ("" nebo HelpNavigator.Find).String.Empty command Pokud argument odkazuje na HelpNavigator.Topic, , HelpNavigator.TopicIdHelpNavigator.KeywordIndexnebo HelpNavigator.AssociateIndex, tato hodnota by měla být řetězec, který obsahuje název tématu, nebo klíčové slovo nebo číselný identifikátor tématu, které se má zobrazit.

Viz také

• ShowHelpIndex(Control, String)