Compartir a través de

Cómo: Proporcionar ayuda en una aplicación Windows

Puede usar el HelpProvider componente para adjuntar temas de Ayuda dentro de un archivo de Ayuda a controles específicos en Formularios Windows Forms. El archivo de ayuda puede ser HTML o HTMLHelp 1.x o un formato superior.

Proporcionar ayuda

  1. En Visual Studio, desde el Cuadro de herramientas, arrastre un HelpProvider componente al formulario.

    El componente residirá en la bandeja de la parte inferior del Diseñador de Windows Forms.

  2. En la ventana Propiedades, establezca la propiedad HelpNamespace en el archivo de ayuda .chm, .col o .htm.

  3. Seleccione otro control que tenga en el formulario y, en la ventana Propiedades , establezca la SetHelpKeyword propiedad .

    Esta es la cadena que se pasa a través del componente HelpProvider al archivo de Ayuda para invocar el tema de Ayuda adecuado.

  4. En la ventana Propiedades , establezca la SetHelpNavigator propiedad en un valor de la HelpNavigator enumeración.

    Esto determina la forma en que se pasa la propiedad HelpKeyword al sistema de Ayuda. En la tabla siguiente se muestran la configuración posible y sus descripciones.

    Nombre de miembro Descripción
    AssociateIndex Especifica que el índice de un tema especificado se realiza en la dirección URL especificada.
    Buscar Especifica que se muestra la página de búsqueda de una dirección URL especificada.
    Índice Especifica que se muestra el índice de una dirección URL especificada.
    Índice de Palabras Clave Especifica una palabra clave para buscar y la acción que se va a realizar en la dirección URL especificada.
    Tabla de Contenidos Especifica que se muestra la tabla de contenido del archivo de ayuda HTML 1.0.
    Tema Especifica que se muestra el tema al que hace referencia la dirección URL especificada.

En tiempo de ejecución, al presionar F1 cuando el control para el que ha establecido las propiedades HelpKeyword y HelpNavigator tiene el foco, se abrirá el archivo de Ayuda asociado a ese HelpProvider componente.

Actualmente, la propiedad HelpNamespace admite archivos de Ayuda en los tres formatos siguientes: HTMLHelp 1.x, HTMLHelp 2.0 y HTML. Por lo tanto, puede establecer la propiedad HelpNamespace en una http:// dirección, como una página web. Si esto se hace, se abrirá el explorador predeterminado a la página web con la cadena especificada en la propiedad HelpKeyword utilizada como ancla. El ancla se utiliza para saltar a una parte específica de una página HTML.

Importante

Tenga cuidado de comprobar cualquier información que se envíe desde un cliente antes de usarla en la aplicación. Los usuarios malintencionados pueden intentar enviar o insertar script ejecutable, instrucciones SQL u otro código. Antes de mostrar la entrada de un usuario, almacénela en una base de datos o trabaje con ella, compruebe que no contiene información potencialmente no segura. Una manera típica de comprobar es usar una expresión regular para buscar palabras clave como "SCRIPT" cuando recibe la entrada de un usuario.

También puede usar el componente HelpProvider para mostrar la Ayuda emergente, incluso si lo ha configurado para mostrar los archivos de Ayuda de los controles en los Formularios de Windows. Para obtener más información, vea Cómo: Mostrar ayuda emergente.

Consulte también