Utilizar el archivo de ayuda con Visual Basic
Llamar a la ayuda desde Visual Basic

 

Las llamadas desde Visual Basic a un archivo de ayuda, pueden ser de 3 tipos.

      A través del botón F1
      Pulsando en un botón
      A través de menú de nuestra aplicación

A través del botón F1

Para llamar a una página del archivo de ayuda a través del botón F1, primeramente debemos indicar la ubicación de dicho archivo.

Para ello, podemos utilizar la instrucción App.HelpFile, la cual recibe la dirección del archivo de ayuda en el disco.

App.HelpFile="C:\mi aplicación\ayuda.hlp"

Esta declaración es conveniente realizarla al inicio del programa, de esta manera servirá para toda la aplicación y no tendremos que volver a declararla en ningún formulario.

Sólo hay que indicar la dirección una vez, no es necesario indicarlo en cada uno de los accesos que realicemos a la ayuda (siempre y cuando, ya esté hecha con anterioridad, la referencia al archivo de ayuda).

El segundo paso, es indicar en la propiedad HelpContextID del formulario o control que emite la solicitud de ayuda, el número que hemos introducido en el archivo HPJ en la declaración Map... que hace referencia a una página de la ayuda.

Si ejecutamos la aplicación, y nos colocamos en el formulario o control que hemos indicado para la ayuda, y pulsamos la tecla F1, nos tiene que aparecer la ventana de ayuda con la página seleccionada.

Pulsando un botón

Para que pulsando un botón, nos aparezca la ayuda de un formulario, necesitamos utilizar el control CommonDialog.

Situamos el control en el formulario, y en el evento KeyPress del botón que hayamos seleccionado para la ayuda colocamos el siguiente texto:

CommonDialog1.HelpContext = 100
CommonDialog1.HelpCommand = cdlHelpContext
CommonDialog1.ShowHelp

CommonDialog1.HelpContext = 100
Determina la página de ayuda a mostrar que hemos determinado en la opción Map... al generar nuestro archivo de ayuda HLP.

CommonDialog1.HelpCommand = cdlHelpContext
Determinamos como tiene que mostrar la ayuda. En este caso nos muestra el archivo de ayuda normal.

Si en vez de poner cdlHelpContext introducimos cdlHelpContextPopup nos mostrará la ayuda en modo emergente.
Si consultamos la ayuda del Visual Basic, encontraremos diferentes maneras de solicitar la ayuda desde nuestro programa.

CommonDialog1.ShowHelp
Muestra la ayuda

A través de menú de nuestra aplicación

Para mostrar la ayuda desde el menú, podemos utilizar las mismas instrucciones que a través de un botón, pero normalmente, al pulsar en el menú la ayuda, lo que se pretende es que aparezca el contenido de la ayuda para que el usuario seleccione la ayuda que desea.

Para ello, utilizaremos la instrucción Shell, la cual ejecuta cualquier archivo del disco duro, en este caso lo utilizamos para el archivo de ayuda.

El código seria algo así:

Dim x
x = Shell("winhelp.exe" & " disco:\directorio\archivo.hlp", vbNormalFocus)

NOTA: Al introducir el nombre del archivo, hay que dejar un espacio en blanco al inicio, para que el nombre del archivo de ayuda, no quede pegado al nombre del programa WinHelp.exe

De esta manera ejecutará el archivo de ayuda mostrando el contenido del mismo. Si el archivo de ayuda no dispone de un contenido, mostrará la primera página.

 

Anterior Siguiente