HelpContextID property

  • Article

HelpContextID property

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

See also         Example         Applies to

Gets or sets the help context ID to be used by a menu or toolbar item.

Version added

4.0

Syntax

        
          object.HelpContextID = intVal
      
        
          intVal = object.HelpContextID

object

Required. An expression that returns a Menu, MenuItem, or ToolbarItem object that has or gets the context ID.

intVal

Integer. The context ID of a topic in a help file.

Remarks

For Visio commands, the HelpContextID property is usually the same value as the CmdNum property, which contains the command ID. Command IDs are declared by the Visio type library and have the prefix visCmd.

By default, the value of the HelpContextID property is zero (0), which displays the Contents topic of the help file indicated by the HelpFile property.

If the value of the HelpContextID property is zero and the object's CmdNum property is set to one of the Visio command IDs, it uses the default help context ID from the built-in Visio user interface.