VpeEnableHelpRouting

<< Click to Display Table of Contents >>

Navigation:  Management Functions >

VpeEnableHelpRouting

Previous pageReturn to chapter overviewNext page

[Windows platform only; not supported by the Community Edition]

If enabled and the Help-Button is visible, pushing the Help-Button or pressing the Help key will cause the event VPE_HELP to be sent to the parent window, no matter if the VPE-Preview window is embedded or not. With this option you are able to present context-sensitive help to your user. If this property is False, VPE’s build-in small help dialog will be shown.

void VpeEnableHelpRouting(

VpeHandle hDoc,

int enabled

)

VpeHandle hDoc

Document Handle

int enabled

Value

Description

True

enabled (help event will be sent)

False

disabled (VPE’s build-in small help dialog will be shown)

Default:

False (VPE’s build-in small help dialog will be shown)