<< Click to Display Table of Contents >> VpeEnableInteraction |
By default, a document which contains controls is not automatically editable by the user, i.e. all controls are locked for editing.
Set this property in order to enable or disable the whole document for editing.
A disabled control can not receive the focus, therefore the user can not change the control's value, neither with the keyboard, nor with the mouse. It is still possible to change the values of disabled controls by code.
The interaction for a document can not be enabled, if the document is stream based, i.e. it is opened using VpeOpenDocFile(). Stream based documents are not editable. If you want the user to edit a .VPE document file, open a memory based document (i.e. use VpeOpenDoc()) and read the document file into memory using VpeReadDoc().
int VpeEnableInteraction(
VpeHandle hDoc,
int yes_no
)
VpeHandle hDoc
Document Handle
int yes_no
Value |
Description |
True |
enable the whole document for editing |
False |
disable the whole document for editing |
Returns:
Value |
Description |
True |
success, interaction could be enabled |
False |
otherwise, i.e. the document is stream based (VpeOpenDocFile() was used) |
"Interactive Documents" in the Programmer's Manual.