VpeEnableCloseButton

<< Click to Display Table of Contents >>

Navigation:  Management Functions >

VpeEnableCloseButton

Previous pageReturn to chapter overviewNext page

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

Specifies, whether the Close Button in the preview is enabled (= activated, so the user can push it).

If the preview is not embedded (ExternalWindow = True), the close controls of the window (Close Button including the system-menu) are also disabled.

You can use this property to temporarily lock the preview from being closed by the user.

void VpeEnableCloseButton(

VpeHandle hDoc,

int enabled

)

VpeHandle hDoc

Document Handle

int enabled

Value

Description

True

enabled

False

disabled

Default:

enabled (= Close Button is enabled)

Remarks:

This property does not control, whether the button is visible in the toolbar or not. (see VpeOpenDoc-Flag: VPE_NO_USER_CLOSE)