Help.ShowHelp Metódus

Definíció

Névtér:

System.Windows.Forms

Szerelvény:

System.Windows.Forms.dll

Megjeleníti a súgófájl tartalmát.

Túlterhelések

Name	Description
ShowHelp(Control, String)	Megjeleníti a súgófájl tartalmát a megadott URL-címen.
ShowHelp(Control, String, String)	Megjeleníti egy adott kulcsszó megadott URL-címén található súgófájl tartalmát.
ShowHelp(Control, String, HelpNavigator)	Megjeleníti egy adott témakör megadott URL-címén található súgófájl tartalmát.
ShowHelp(Control, String, HelpNavigator, Object)	Megjeleníti a súgófájl tartalmát a felhasználó által megadott URL-címen.

ShowHelp(Control, String)

Forrás:

Help.cs

Megjeleníti a súgófájl tartalmát a megadott URL-címen.

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)

Paraméterek

parent

Control

A Control Súgó párbeszédpanel szülőjének azonosítására szolgáló beállítás.

url

String

A súgófájl elérési útja és neve.

Példák

Az alábbi példakód a metódust ShowHelp mutatja be. A példa futtatásához illessze be a következő kódot egy olyan űrlapba, amely egy nevesített Button1gombot tartalmaz.

// 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

Megjegyzések

Az url argumentum lehet C:\path\sample.chm vagy /folder/file.htm. Az elérési utak formátumával kapcsolatos információkért lásd: File path format on Windows systems.

Lásd még

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, String)

Forrás:

Help.cs

Megjeleníti egy adott kulcsszó megadott URL-címén található súgófájl tartalmát.

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)

Paraméterek

parent

Control

A Control Súgó párbeszédpanel szülőjének azonosítására szolgáló beállítás.

url

String

A súgófájl elérési útja és neve.

keyword

String

A súgó megjelenítéséhez használt kulcsszó.

Példák

Az alábbi kódpéldában egy három gombot tartalmazó űrlap jelenik meg, amely az mspaint.chm súgófájllal való interakcióhoz használható. A Súgóindex megjelenítése gomb megjeleníti a súgófájl Index lapját. A Súgó megjelenítése gomb a súgófájl tartalmát jeleníti meg a Súgókezelő listában kiválasztott érték alapján. A Kulcsszó megjelenítése gomb a Súgófájl tartalmát jeleníti meg a Kulcsszó szövegmezőben megadott kulcsszó alapján.

Ha például az Ovális súgólapot az index értéke alapján szeretné megjeleníteni, jelölje ki az HelpNavigator.KeywordIndex értéket a Súgó kezelője legördülő listában, írja be az oválisakat a Paraméter szövegmezőbe, majd kattintson a Súgó megjelenítése gombra. Ha a kulcsszó szerint meg szeretné jeleníteni a "Festék ecsettel" súgótémakört, írja be az mspaint.chm::/paint_brush.htm kifejezést a Kulcsszó szövegmezőbe, majd kattintson a Kulcsszó megjelenítése gombra.

Ez a példa csak a metódus hívását ShowHelp mutatja be. A teljes kód példáját az Help osztály áttekintésében tekintheti meg.

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

Megjegyzések

Az url argumentum lehet C:\path\sample.chm vagy /folder/file.htm. Az elérési utak formátumával kapcsolatos információkért lásd: File path format on Windows systems.

Ha keyword igen null, megjelenik a súgófájl tartalomjegyzéke.

Lásd még

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator)

Forrás:

Help.cs

Megjeleníti egy adott témakör megadott URL-címén található súgófájl tartalmát.

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)

Paraméterek

parent

Control

A Control Súgó párbeszédpanel szülőjének azonosítására szolgáló beállítás.

url

String

A súgófájl elérési útja és neve.

navigator

HelpNavigator

Az egyik HelpNavigator érték.

Példák

Az alábbi példakód bemutatja, hogyan lehet a ShowHelp metódussal megnyitni egy súgófájlt az indexoldalán. A példa futtatásához illessze be a következő kódot egy olyan űrlapba, amely egy nevesített Button2gombot tartalmaz.

// 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

Megjegyzések

Az url argumentum lehet C:\path\sample.chm vagy /folder/file.htm. Az elérési utak formátumával kapcsolatos információkért lásd: File path format on Windows systems.

A lefordított súgófájlok tartalomjegyzéket, indexet, keresést és kulcsszóhivatkozásokat biztosítanak a lapokban. Az argumentumhoz navigator a következő értékeket használhatja: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Indexvagy HelpNavigator.Topic.

Lásd még

• ShowHelpIndex(Control, String)

ShowHelp(Control, String, HelpNavigator, Object)

Forrás:

Help.cs

Megjeleníti a súgófájl tartalmát a felhasználó által megadott URL-címen.

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)

Paraméterek

parent

Control

A Control Súgó párbeszédpanel szülőjének azonosítására szolgáló beállítás.

url

String

A súgófájl elérési útja és neve.

command

HelpNavigator

Az egyik HelpNavigator érték.

parameter

Object

A témakör azonosítót tartalmazó sztring.

Kivételek

ArgumentException

parameter egész szám.

Példák

Az alábbi kódpéldában egy három gombot tartalmazó űrlap jelenik meg, amely az mspaint.chm súgófájllal való interakcióhoz használható. A Súgóindex megjelenítése gomb megjeleníti a súgófájl Index lapját. A Súgó megjelenítése gomb a súgófájl tartalmát jeleníti meg a Súgókezelő listában kiválasztott érték alapján. A Kulcsszó megjelenítése gomb a Súgófájl tartalmát jeleníti meg a Kulcsszó szövegmezőben megadott kulcsszó alapján.

Ha például az Ovális súgólapot az index értéke alapján szeretné megjeleníteni, jelölje ki az HelpNavigator.KeywordIndex értéket a Súgó kezelője legördülő listában, írja be az oválisakat a Paraméter szövegmezőbe, majd kattintson a Súgó megjelenítése gombra. Ha a kulcsszó szerint meg szeretné jeleníteni a "Festék ecsettel" súgótémakört, írja be az mspaint.chm::/paint_brush.htm kifejezést a Kulcsszó szövegmezőbe, majd kattintson a Kulcsszó megjelenítése gombra.

Ez a példa csak a metódus hívását ShowHelp mutatja be. A teljes kód példáját az Help osztály áttekintésében tekintheti meg.

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

Megjegyzések

Az url argumentum lehet C:\path\sample.chm vagy /folder/file.htm. Az elérési utak formátumával kapcsolatos információkért lásd: File path format on Windows systems.

A lefordított súgófájlok tartalomjegyzéket, indexet, keresést és kulcsszóhivatkozásokat biztosítanak a lapokban. Az parameter argumentum használatával további pontosítást adhat a HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndexvagy HelpNavigator.AssociateIndex parancshoz. Ha az argumentumban commandmegadott érték egy HelpNavigator.TableOfContentsüres sztring ("" vagy HelpNavigator.IndexHelpNavigator.Find).String.Empty Ha az command argumentum arra hivatkozikHelpNavigator.Topic, HelpNavigator.TopicIdHelpNavigator.KeywordIndexhogy HelpNavigator.AssociateIndexez az érték egy olyan sztring legyen, amely tartalmazza a témakör nevét, vagy a megjelenítendő témakör kulcsszóját vagy numerikus azonosítóját.

Lásd még

• ShowHelpIndex(Control, String)