VpeSetPictureEmbedInDoc

<< Click to Display Table of Contents >>

Navigation:  Picture Functions >

VpeSetPictureEmbedInDoc

Previous pageReturn to chapter overviewNext page

When writing a VPE document to file (either by working with SwapFileName, or WriteDoc), this property enforces that the image will be stored directly in the VPE document file with all its binary data. If this property is set to false, an image is stored with its pathname link (which will need much less space: just a few bytes) in a VPE document. Setting this property to true is useful, if the location of the referenced image changes, or if you transport a VPE document file to another system, where the image is not available (for example by e-mail).

VPE embeds images highly optimized within document files:

Images are only stored once within a document file, regardless how often they are used (for example on each page).

Compressed images (TIF, GIF, JPG, PNG) are stored in their original form, i.e. the images are copied directly and unchanged from the hard disk into a VPE document.

Uncompressed images will be flate compressed (using the ZLIB), if compression for the document file is activated (which is the default).

For details about creating and using VPE document files, please see the "Programmer's Manual", chapter "Programming Techniques", subchapter "VPE Document Files".

void VpeSetPictureEmbedInDoc(

VpeHandle hDoc,

int on_off

)

VpeHandle hDoc

Document Handle or VPE Object Handle

int on_off

Value

Description

True

on

False

off

Default:

True

Remarks:

ATTENTION: When you read one or more VPE document files into the current document using ReadDoc(), and those files have embedded images, you may NOT delete or modify the source document files, while the current document is open! This is, because VPE loads the embedded images directly out of the source document files each time they are not found in the image cache.

 

See Also:

"Pictures" in the Programmer's Manual