Help.ShowHelpIndex(Control, String) Metod

Definition

Namnområde:
System.Windows.Forms
Sammansättning:
System.Windows.Forms.dll
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs
Källa:
Help.cs

Visar indexet för den angivna hjälpfilen.

public:
 static void ShowHelpIndex(System::Windows::Forms::Control ^ parent, System::String ^ url);
public static void ShowHelpIndex(System.Windows.Forms.Control parent, string url);
public static void ShowHelpIndex(System.Windows.Forms.Control? parent, string? url);
static member ShowHelpIndex : System.Windows.Forms.Control * string -> unit
Public Shared Sub ShowHelpIndex (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 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 ShowHelpIndex till metoden. Se klassöversikten Help för det fullständiga kodexemplet.

private:
   void showIndex_Click( Object^ /*sender*/, System::EventArgs^ /*e*/ )
   {
      
      // Display the index for the help file.
      Help::ShowHelpIndex( this, helpfile );
   }

private void showIndex_Click(object sender, System.EventArgs e)
{
    // Display the index for the help file.
    Help.ShowHelpIndex(this, helpfile);
}

Private Sub showIndex_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles showIndex.Click
    ' Display the index for the Help file.
    Help.ShowHelpIndex(Me, helpfile)
End Sub

Kommentarer

Parametern url kan vara av formatet C:\path\sample.chm eller /folder/file.htm.

Gäller för

Se även