InvokeHelp method

Microsoft Visio Developer Reference

previous page next page

InvokeHelp method

See also   Example   

Performs Help operations using the Microsoft Visio Help system.

Version added

2002

Syntax

object.InvokeHelp bstrHelpFileName, command, data

object

Required. An expression that returns an Application object.

bstrHelpFileName

Required String. Specifies an HTML file, a URL, a compiled HTML file, or an optional window definition (preceded with a ">" character). If the command being used does not require a file or URL, this value may be "".

command

Required Long. The action to perform.

data

Required Long. Any data that is required based on the value of the command argument.

Remarks

Using the InvokeHelp method, you can create a custom Help system that is integrated with the Visio Help system. To enable your custom Help to appear in the same tiled MSO Help window as Visio Help, do not specify a window definition in the bstrHelpFileName argument.

The arguments passed to the InvokeHelp method correspond to those described in the HTML Help API. For a list of command values, see the HTML Help API Reference on the Microsoft Developer Network (MSDN) Web site. Microsoft Visual Basic programmers can use the numeric equivalent of the C++ constants defined in the HTML Help API header files.

For example, use the following code to show the default Visio Help window:

Application.InvokeHelp "Visio.chm", 15, 0

Or use the following code to hide the Visio Help window:

Application.InvokeHelp "", 18, 0

For more information about the HTML Help API, search for "HTML Help API overview" on the MSDN Web site.

previous page start next page