Help.ShowHelpIndex(Control, String) Método

Definición

Muestra el índice del archivo de Ayuda especificado.Displays the index of the specified Help file.

public:
 static void ShowHelpIndex(System::Windows::Forms::Control ^ parent, System::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)

Parámetros

parent
Control

Control que identifica el elemento primario del cuadro de diálogo de Ayuda.A Control that identifies the parent of the Help dialog box.

url
String

Ruta de acceso y nombre del archivo de Ayuda.The path and name of the Help file.

Ejemplos

En el ejemplo de código siguiente se muestra un formulario con tres botones que se pueden usar para interactuar con el archivo de ayuda mspaint. chm.The following code example displays a form with three buttons that can be used to interact with the mspaint.chm Help file. El botón Mostrar índice de ayuda muestra la pestaña Índice del archivo de ayuda.The Show Help Index button displays the Index tab for the Help file. El botón Mostrar ayuda muestra el contenido del archivo de ayuda en función del valor seleccionado en la lista navegador de la ayuda.The Show Help button displays content in the Help file based on the value that is selected in the Help Navigator list. El botón Mostrar palabra clave muestra el contenido en el archivo de ayuda en función de la palabra clave que se especifica en el cuadro de texto palabra clave .The Show Keyword button displays content in the Help file based on the keyword that is specified in the Keyword text box.

Por ejemplo, para mostrar la página de ayuda de óvalos por el valor de índice, seleccione el HelpNavigator.KeywordIndex valor en la lista desplegable navegador de ayuda , escriba óvalos en el cuadro de texto de parámetro y, a continuación, haga clic en el botón Mostrar ayuda .For example, to show the Ovals Help page by the index value, select the HelpNavigator.KeywordIndex value in the Help Navigator drop-down list, type ovals in the Parameter text box, and then click the Show Help button. Para mostrar el tema de ayuda "para pintar con un pincel" mediante la palabra clave, escriba mspaint. chm::/paint_brush.htm en el cuadro de texto palabra clave y, a continuación, haga clic en el botón Mostrar palabra clave .To show the "To paint with a brush" Help topic by the keyword, type mspaint.chm::/paint_brush.htm in the Keyword text box, and then click the Show Keyword button.

En este ejemplo se muestra solo la llamada al ShowHelpIndex método.This example shows only the call to the ShowHelpIndex method. Vea la Help información general de la clase para obtener el ejemplo de código completo.See the Help class overview for the complete code example.

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

Comentarios

El url parámetro puede tener el formato c:\ruta\ejemplo.chm o/folder/file.htm.The url parameter can be of the form C:\path\sample.chm or /folder/file.htm.

Se aplica a

Consulte también