VpeSetExportNonPrintableObjects

<< Click to Display Table of Contents >>

Navigation:  Layout Functions >

VpeSetExportNonPrintableObjects

Previous pageReturn to chapter overviewNext page

[Professional Edition and above]

By default, objects which are marked as non-printable are not exported to external file formats (for example to images or PDF). If this property is set to True, all objects of a document which are marked as non-printable are exported, too.

This property is document-wide in effect, it does not affect single objects.

void VpeSetExportNonPrintableObjects(

VpeHandle hDoc,

int yes_no

)

VpeHandle hDoc

Document Handle

int yes_no

possible values are:

Value

Description

True

1: yes, export objects which are marked as non-printable

False

0: no, do not export objects which are marked as non-printable

Default:

False, do not export objects which are marked as non-printable

Remarks:

This property does not affect VPE Document files (.VPE files). Objects which are marked as non-printable are always written to VPE Document files. The property is only relevant for export operations to external file formats, like PDF or image files.

 

But the setting of this property is also written to VPE Document files, i.e. if you read a VPE Document file, the setting of this property is read from the file.

Example: you set the property = true and write a document to the file "test.vpe". Later you open a new document, so by default this property is false, but after you call VpeReadDoc("test.vpe"), the property will be true, because it is read from "test.vpe".

 

The setting of this property also affects how VPE will create PDF file attachments when sending e-mails. Furthermore it affects in the same way the document viewer VPEView.

 

You can set the property temporarily = True before exporting a document, and immediately afterwards back to False. This assures that it is not written to a VPE Document file.