VpeSetBookmarkDestination

<< Click to Display Table of Contents >>

Navigation:  PDF Export >

VpeSetBookmarkDestination

Previous pageReturn to chapter overviewNext page

[VPE Professional Edition and above]

Sets the destination for subsequently added bookmarks.

void VpeSetBookmarkDestination(

VpeHandle hDoc,

int bkm_type,

int left,

int top,

int right,

int bottom,

double zoom_factor

)

VpeHandle hDoc

Document Handle

int bkm_type

Bookmark Type, possible values are:

 

Constant Name

Value

Comment

VBOOKMARK_DEST_NONE

0

No Destination

VBOOKMARK_DEST_LTZ

1

Normal Destination (left, top, zoom are used) - this is the default
Display the target page with the coordinates (left, top) positioned at the top-left corner of the window and the contents of the page magnified by the zoom_factor. A null value for any of the parameters left, top, or zoom_factor specifies that the current value of that parameter is to be retained unchanged.

VBOOKMARK_DEST_FIT

2

Fit the page in the window (no coordinates used)
Display the target page with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

VBOOKMARK_DEST_FITH

3

Fit the page in the window horizontally (top coordinate used)
Display the target page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window.

VBOOKMARK_DEST_FITV

4

Fit the page in the specified rectangle (all coordinates used)
Display the target page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.

VBOOKMARK_DEST_FITR

5

Fit the page in the specified rectangle (all coordinates used)
Display the target page with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.

VBOOKMARK_DEST_FITB

6

Fit the page's bounding rectangle in the window
Display the target page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.

VBOOKMARK_DEST_FITBH

7

Fit the page's bounding rectangle horizontally in the window (top coordinate used)
Display the target page with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window.

VBOOKMARK_DEST_FITBV

8

Fit the page's bounding rectangle vertically in the window (left coordinate used)
Display the target page with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window.

int left, int top, int right, int bottom

position and dimensions

double zoom_factor

zoom factor, e.g.: 0.5 = 50%; 1.0 = 100%; 2.0 = 200%; etc.

Default:

VBOOKMARK_DEST_LTZ