VCOM:VectorWorks:ISDK::DisplayContextualHelp

From Vectorworks Developer
Jump to: navigation, search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks

Member of VCOM:VectorWorks:ISDK

Using the identifier string for a GUI element (tool, menu item, dialog) given by the Contextual Help Manager displays the associated contextual help. This could be a WebWorks webpage, a Internet webpage or even a local file.

virtual bool DisplayContextualHelp(
const TXString& helpIdentifier)

Parameters

const TXString& helpIdentifier String containing identifier for the GUI element.

Return Value

On error returns: false

Remarks

The parameter 'helpIdentifier' is in the format:
"net.<company>.help.XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
  • '<comany>' name of the company that provides help.
  • ('X's are heximal numbers from unique UUID)

For example, NNA's help looks like this:

"net.nemetschek.help.11F00359-DA7B-11DC-9BB1-001AA0D70350"

Version

Availability: from Vectorworks 2009
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox