Help.ShowHelp Metod

Definition

Visar innehållet i en hjälpfil.

Överlagringar

Name Description
ShowHelp(Control, String)

Visar innehållet i hjälpfilen på den angivna URL:en.

ShowHelp(Control, String, String)

Visar innehållet i hjälpfilen som finns på den angivna URL:en för ett visst nyckelord.

ShowHelp(Control, String, HelpNavigator)

Visar innehållet i hjälpfilen som finns på den angivna URL:en för ett visst ämne.

ShowHelp(Control, String, HelpNavigator, Object)

Visar innehållet i hjälpfilen som finns på den URL som användaren anger.

ShowHelp(Control, String)

Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs

Visar innehållet i hjälpfilen på den angivna URL:en.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url);
public static void ShowHelp(System.Windows.Forms.Control parent, 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)

Parametrar

parent
Control

En Control som identifierar överordnad i dialogrutan Hjälp.

url
String

Sökvägen och namnet på hjälpfilen.

Exempel

I följande kodexempel visas ShowHelp metoden. Om du vill köra det här exemplet klistrar du in följande kod i ett formulär som innehåller en knapp med namnet 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

Kommentarer

Argumentet url kan vara av formatet C:\path\sample.chm eller /folder/file.htm. Information om sökvägarnas format finns i sökvägsformaten File på Windows system.

Se även

Gäller för

ShowHelp(Control, String, String)

Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs

Visar innehållet i hjälpfilen som finns på den angivna URL:en för ett visst nyckelord.

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

Parametrar

parent
Control

En Control som identifierar överordnad i dialogrutan Hjälp.

url
String

Sökvägen och namnet på hjälpfilen.

keyword
String

Nyckelordet som ska visas i Hjälp för.

Exempel

I följande kodexempel visas ett formulär med tre knappar som kan användas för att interagera med hjälpfilen mspaint.chm. Knappen Visa hjälpindex visar fliken Index för hjälpfilen. Knappen Visa hjälp visar innehåll i hjälpfilen baserat på det värde som har valts i listan Hjälpnavigering . Knappen Visa nyckelord visar innehåll i hjälpfilen baserat på nyckelordet som anges i textrutan Nyckelord .

Om du till exempel vill visa sidan Ovals-hjälp efter indexvärdet väljer du HelpNavigator.KeywordIndex värdet i listrutan Hjälp navigatör , skriver ovaler i textrutan Parameter och klickar sedan på knappen Visa hjälp . Om du vill visa hjälpavsnittet "Att måla med en pensel" efter nyckelordet skriver du mspaint.chm::/paint_brush.htm i textrutan Nyckelord och klickar sedan på knappen Visa nyckelord .

I det här exemplet visas bara anropet ShowHelp till metoden. Se klassöversikten Help för det fullständiga kodexemplet.

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

Kommentarer

Argumentet url kan vara av formatet C:\path\sample.chm eller /folder/file.htm. Information om sökvägarnas format finns i sökvägsformaten File på Windows system.

Om keyword är nullvisas innehållsförteckningen för hjälpfilen.

Se även

Gäller för

ShowHelp(Control, String, HelpNavigator)

Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs

Visar innehållet i hjälpfilen som finns på den angivna URL:en för ett visst ämne.

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

Parametrar

parent
Control

En Control som identifierar överordnad i dialogrutan Hjälp.

url
String

Sökvägen och namnet på hjälpfilen.

navigator
HelpNavigator

Ett av HelpNavigator värdena.

Exempel

I följande kodexempel visas hur du använder ShowHelp metoden för att öppna en hjälpfil på indexsidan. Om du vill köra det här exemplet klistrar du in följande kod i ett formulär som innehåller en knapp med namnet 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

Kommentarer

Argumentet url kan vara av formatet C:\path\sample.chm eller /folder/file.htm. Information om sökvägarnas format finns i sökvägsformaten File på Windows system.

Kompilerade hjälpfiler innehåller innehållsförteckningar, index-, sök- och nyckelordslänkar på sidor. Du kan använda följande värden för navigator argumentet: HelpNavigator.TableOfContents, HelpNavigator.Find, HelpNavigator.Index, eller HelpNavigator.Topic.

Se även

Gäller för

ShowHelp(Control, String, HelpNavigator, Object)

Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs

Visar innehållet i hjälpfilen som finns på den URL som användaren anger.

public:
 static void ShowHelp(System::Windows::Forms::Control ^ parent, System::String ^ url, System::Windows::Forms::HelpNavigator command, System::Object ^ param);
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 param);
public static void ShowHelp(System.Windows.Forms.Control parent, string url, System.Windows.Forms.HelpNavigator command, 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
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, param As Object)
Public Shared Sub ShowHelp (parent As Control, url As String, command As HelpNavigator, parameter As Object)

Parametrar

parent
Control

En Control som identifierar överordnad i dialogrutan Hjälp.

url
String

Sökvägen och namnet på hjälpfilen.

command
HelpNavigator

Ett av HelpNavigator värdena.

paramparameter
Object

En sträng som innehåller ämnesidentifieraren.

Undantag

parameter är ett heltal.

Exempel

I följande kodexempel visas ett formulär med tre knappar som kan användas för att interagera med hjälpfilen mspaint.chm. Knappen Visa hjälpindex visar fliken Index för hjälpfilen. Knappen Visa hjälp visar innehåll i hjälpfilen baserat på det värde som har valts i listan Hjälpnavigering . Knappen Visa nyckelord visar innehåll i hjälpfilen baserat på nyckelordet som anges i textrutan Nyckelord .

Om du till exempel vill visa sidan Ovals-hjälp efter indexvärdet väljer du HelpNavigator.KeywordIndex värdet i listrutan Hjälp navigatör , skriver ovaler i textrutan Parameter och klickar sedan på knappen Visa hjälp . Om du vill visa hjälpavsnittet "Att måla med en pensel" efter nyckelordet skriver du mspaint.chm::/paint_brush.htm i textrutan Nyckelord och klickar sedan på knappen Visa nyckelord .

I det här exemplet visas bara anropet ShowHelp till metoden. Se klassöversikten Help för det fullständiga kodexemplet.

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

Kommentarer

Argumentet url kan vara av formatet C:\path\sample.chm eller /folder/file.htm. Information om sökvägarnas format finns i sökvägsformaten File på Windows system.

Kompilerade hjälpfiler innehåller innehållsförtecknings-, index-, sök- och nyckelordslänkar på sidor. Du kan använda parameter argumentet för att ange ytterligare förfining av HelpNavigator.Topickommandot , HelpNavigator.TopicId, HelpNavigator.KeywordIndexeller HelpNavigator.AssociateIndex . Om värdet som anges i command argumentet är HelpNavigator.TableOfContents, HelpNavigator.Indexeller HelpNavigator.Find, ska det här värdet vara en tom sträng ("" eller String.Empty). command Om argumentet refererar till HelpNavigator.Topic, HelpNavigator.TopicId, HelpNavigator.KeywordIndexeller HelpNavigator.AssociateIndex, bör det här värdet vara en sträng som innehåller ämnesnamnet, eller nyckelordet eller den numeriska identifierare för ämnet som ska visas.

Se även

Gäller för