Help.ShowHelp Metoda

Definice

Obor názvů:

System.Windows.Forms

Sestavení:

System.Windows.Forms.dll

Zobrazí obsah souboru nápovědy.

Přetížení

ShowHelp(Control, String)	Zobrazí obsah souboru nápovědy na zadané adrese URL.
ShowHelp(Control, String, String)	Zobrazí obsah souboru nápovědy nalezený na zadané adrese URL pro konkrétní klíčové slovo.
ShowHelp(Control, String, HelpNavigator)	Zobrazí obsah souboru nápovědy, který se nachází na zadané adrese URL pro konkrétní téma.
ShowHelp(Control, String, HelpNavigator, Object)	Zobrazí obsah souboru nápovědy, který se nachází na adrese URL zadané uživatelem.

ShowHelp(Control, String)

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řazený prvek 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 spustit tento příklad, 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

Argument url může mít formát C:\path\sample.chm nebo /folder/file.htm. Informace o formátu cest najdete v tématu Formáty cest k souborům v systémech Windows.

Viz také

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Zobrazí obsah souboru nápovědy nalezený 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řazený prvek dialogového okna Nápověda.

url

String

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

keyword

String

Klíčové slovo, pro které se má zobrazit nápověda.

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 rejstřík nápovědy zobrazí kartu Index pro soubor nápovědy. Tlačítko Zobrazit nápovědu zobrazí obsah 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 .

Pokud chcete například zobrazit stránku Nápověda k oválům 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 potom klikněte na tlačítko Zobrazit nápovědu . Chcete-li zobrazit téma nápovědy "Malování štětcem" 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 Help přehledu 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

Argument url může mít formát C:\path\sample.chm nebo /folder/file.htm. Informace o formátu cest najdete v tématu Formáty cest k souborům v systémech Windows.

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

Viz také

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Zobrazí obsah souboru nápovědy, který se nachází na zadané adrese URL pro konkrétní téma.

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řazený prvek 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 indexovou stránku. Pokud chcete spustit tento příklad, 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

Argument url může mít formát C:\path\sample.chm nebo /folder/file.htm. Informace o formátu cest najdete v tématu Formáty cest k souborům v systémech Windows.

Kompilované soubory nápovědy poskytují na stránkách odkazy na obsah, rejstřík, hledání a klíčová slova. 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)

Zobrazí obsah souboru nápovědy, který se nachází 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řazený prvek 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 rejstřík nápovědy zobrazí kartu Index pro soubor nápovědy. Tlačítko Zobrazit nápovědu zobrazí obsah 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 .

Pokud chcete například zobrazit stránku Nápověda k oválům 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 potom klikněte na tlačítko Zobrazit nápovědu . Chcete-li zobrazit téma nápovědy "Malování štětcem" 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 Help přehledu 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

Argument url může mít formát C:\path\sample.chm nebo /folder/file.htm. Informace o formátu cest najdete v tématu Formáty cest k souborům v systémech Windows.

Kompilované soubory nápovědy poskytují na stránkách odkazy na obsah, index, hledání a klíčová slova. Argument můžete použít parameter k dalšímu upřesnění HelpNavigator.Topicpříkazu , HelpNavigator.TopicId, HelpNavigator.KeywordIndex, nebo HelpNavigator.AssociateIndex . Pokud je hodnota zadaná v argumentu command , HelpNavigator.Indexnebo HelpNavigator.Find, měla by to být prázdná hodnota řetězce ("" nebo String.Empty).HelpNavigator.TableOfContents command Pokud argument odkazuje na HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndexnebo HelpNavigator.AssociateIndex, měla by to být hodnota řetězce obsahujícího název tématu nebo klíčové slovo nebo číselný identifikátor tématu, který se má zobrazit.

Viz také

• ShowHelpIndex(Control, String)