Información general sobre el componente HelpProvider (formularios Windows Forms)

  • Artículo

Actualización: noviembre 2007

El componente HelpProvider de formularios Windows Forms se utiliza para asociar un archivo de Ayuda HTML Help 1.x (ya sea un archivo .chm, generado con HTML Help Workshop o un archivo .htm) a una aplicación para Windows. Puede proporcionar ayuda de varias maneras:

  • Proporcionar ayuda contextual para controles de formularios Windows Forms.

  • Proporcionar ayuda contextual sobre un cuadro de diálogo en particular o sobre controles específicos de un cuadro de diálogo.

  • Abrir un archivo de Ayuda en áreas específicas, como la página principal de una Tabla de contenido, el Índice o una función de búsqueda.

Utilizar el proveedor de ayuda

Al agregar un componente HelpProvider a su formulario Windows Forms permite a los otros controles del formulario exponer las propiedades de ayuda del componente HelpProvider. Esto le permite proporcionar ayuda para los controles en su formulario Windows Forms. Puede asociar un archivo de Ayuda al componente HelpProvider por medio de la propiedad HelpNamespace. Para especificar el tipo de ayuda que se desea proporcionar, llame al método SetHelpNavigator y proporcione un valor de la enumeración HelpNavigator al control especificado. Para proporcionar la palabra clave o tema de la ayuda, llame al método SetHelpKeyword.

Opcionalmente, puede utilizar el método SetHelpString para asociar una cadena de Ayuda específica a otro control. Cuando el usuario presione la tecla F1 mientras el control tiene el foco, la cadena asociada por medio de este método se mostrará en una ventana emergente.

Si no se ha establecido HelpNamespace, debe utilizar SetHelpString para proporcionar el texto de la Ayuda. Si estableció tanto HelpNamespace como la cadena de Ayuda, tendrá precedencia la Ayuda basada en HelpNamespace.

Nota:

Podría encontrar problemas si utiliza la ruta acceso relativa al especificar la ruta de acceso al archivo de Ayuda en el método ShowHelp o la propiedadHelpNamespace del controlHelpProvider. Por tanto, asegúrese de utilizar la ruta absoluta de acceso al archivo para especificar el archivo de Ayuda.

Vea también

Conceptos

Sistemas de ayuda en aplicaciones de Windows Forms