Help.ShowHelpIndex(Control, String) Método

Definición

Espacio de nombres:

System.Windows.Forms

Ensamblado:

System.Windows.Forms.dll

Muestra el índice del archivo de Ayuda especificado.

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.

url

String

Ruta de acceso y nombre del archivo de Ayuda.

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. El botón Mostrar índice de ayuda muestra la pestaña Índice del archivo de Ayuda. El botón Mostrar ayuda muestra contenido en el archivo de Ayuda en función del valor seleccionado en la lista Navegador de ayuda . El botón Mostrar palabra clave muestra contenido en el archivo de Ayuda en función de la palabra clave especificada en el cuadro de texto Palabra clave .

Por ejemplo, para mostrar la página Ayuda de Ovales por el valor de índice, seleccione el HelpNavigator.KeywordIndex valor en la lista desplegable Navegador de ayuda , escriba óvalos en el cuadro de texto Parámetro y, a continuación, haga clic en el botón Mostrar ayuda . Para mostrar el tema de ayuda "Para pintar con un pincel" por 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 .

En este ejemplo solo se muestra la llamada al ShowHelpIndex método . Consulte la información general de la Help clase para obtener el ejemplo de código completo.

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:\path\sample.chm o /folder/file.htm.

Consulte también

• ShowHelp(Control, String)