CIB pdf toolbox technical guide (EN)

OutlinesDeleteExisting

String

Remove all outlines or bookmarks from input documents.

Possible values:

„0“: The existing outlines will not be removed. (default)

„1“: All existing outlines will be removed.

Set

OutlinesAdd

String

Adding new outlines and bookmarks to the output PDF document. If bookmarks already exist and should be kept (i.e. OutlinesDeleteExisting=0), the new bookmarks are added to the existing ones.

Possible values:

„ “: No outlines will be added. (default)

A non-empty string: The outlines specified in this property are inserted into the output PDF.                                                        If the syntax is incorrect: error code 349 (CIBPDF_ERROR_OUTLINES_ADD_WRONG_FORMAT)
 

Syntax:

<outlinelist> ::= <outline> | <outline> “;” <outlinelist>

<outline> ::= <outline-with-descendants> | <outline-without-descendants>

<outline-with-descendants> ::= “{” <page> “;{” <destination> “};” <outlinetext> “;{” <outlinedescendants> “}}”

<outline-without-descendants> ::= “{” <page> “;{” <destination> “};” <outlinetext> “}” | “{” <page> “;{” <destination> “};” <outlinetext> “;{}}”

<page> ::= <Integer>

<outlinetext> ::= <text>

<outlinedescendants> ::= <outlinelist>

<destination> ::= <XYZ> | <Fit> | <FitH> | <FitV> | <FitR> | <FitB> | <FitBH> | <FitBV>

<XYZ> ::= „XYZ“ „;“ <Integer> „;“ <Integer> „;“ <Integer>

<Fit> ::= “Fit”

<FitH> ::= “FitH” “;” <Integer>

<FitV> ::= „FitV“ „;“ <Integer>

<FitR> ::= „FitR“ „;“ <Integer> „;“ <Integer> „;“ <Integer> „;“ <Integer>

<FitB> ::= „FitB“

<FitBH> ::= „FitBH“ „;“ <Integer>

<FitBV> ::= „FitBV“ „;“ <Integer>

See next sections for details and examples.

Set

(from CIB pdf toolbox 1.10.0 onwards)

Property returns a string with identical structure.

Get

XYZ

XYZ;number1; number2;
number3

The specified page is displayed so that the x-y coordinate (number1;number2) of the page is at the top left of the window. Number3 is the zoom factor for the page (e.g. Number3=1 is a zoom of 100%, Number3=2 is a zoom of 200%, etc.). Especially number3=0 means that the current zoom factor remains unchanged.

Fit

Fit

The specified page will be enlarged so much that the page fills the window exactly. If this is not possible exactly, the page is enlarged so that the page is always completely visible in the window. One dimension of the page then fills the window exactly. The other dimension of the page is then smaller than the window and is centred within the window.

FitH

FitH;number1

The specified page is displayed so that the y-coordinate number1 of the page is displayed exactly at the top of the window. At the same time, the page is enlarged so that the width of the page fills the window exactly.

FitV

FitV; number1

The specified page is displayed so that the x-coordinate number1 of the page is displayed exactly on the left edge of the window. At the same time, the page is enlarged so that the height of the page fills the window exactly.

FitR

FitR; number1; number2;
number3; number4

The values (number1;number2;number3;number4) are the coordinates of a rectangle within the page (x-value-left;y-value-bottom;x-value-right;y-value-top). The page is displayed and enlarged so that this rectangle fills the window exactly. If this is not possible exactly, the page is enlarged so that the rectangle is always completely visible in the window. One dimension of the rectangle then fills the window exactly while the other dimension of the rectangle is smaller than the window and is centered within the window.

FitB

FitB

The specified page is enlarged so that the page's bounding box exactly fills the window. If this is not possible, the page is enlarged so that the page's bounding box is always completely visible in the window. One dimension of the bounding box then fills the window exactly while the other dimension of the bounding box rectangle is smaller than the window and is centered within the window.

FitBH

FitBH;number1

The specified page is displayed so that the y-coordinate number1 of the page is displayed exactly at the top of the window. At the same time, the page is enlarged so that the width of the page's bounding box fills the window exactly.

FitBV

FitBV;number1

The specified page is displayed so that the x-coordinate number1 of the page is displayed exactly at the left edge of the window. At the same time, the page is enlarged so that the height of the page's bounding box fills the window exactly.