Bookmarks

<< Click to Display Table of Contents >>

Navigation:  Drivers API > IPXCPrinter Interface > Properties > Property Options >

Bookmarks


 

PRO SDK Icon Bookmarks

 


 

The Bookmarks properties activate automatic bookmark tree creation for printed documents and define the parameters used in the process. Please note that properties are case-sensitive:

 

 

NAME

 

 

VALUES

 

DEFINITION

Enabled

Boolean Value

 

Enables the automatic creation of a bookmark tree within the document. If set to False then a bookmark tree is not created and no further properties from this section are used.

 

Default value: False

 

AllowMultiLine

Boolean Value

 

Activates the detection of multiline bookmark items.

 

Default value: True

 

DocTitleAsRoot

Boolean Value

 

If set to True then the root element of the bookmarks tree will be used as the document title. All other top-level bookmarks will be children of this root.

 

Default value: False

 

MatchLevel

Boolean Value

 

If set to True then non-top-level items will be added to the tree only if a previously-detected item of a higher level already exists.

 

If set to False then all detected items will be added to the tree. Dummy parents will be added when no parent is detected at a higher level.

 

Default value: False

 

DisplayMode

0 (AllOpened)

1 (AllClosed)

2 (ByItem)

3 (OpenToLevel)

 

 

Defines which items of the bookmarks tree are expanded automatically when documents are opened.

 

0 (AllOpened) expands all items.

 

1 (AllClosed) expands no items.

 

2 (ByItem) expands items according to the Template definition (see below).

 

3 (OpenToLevel) expands items up to the level that UpToLevel specifies.

 

Default value: 2 (ByItem)

 

UpToLevel

Integer

 

Defines the level of the bookmarks tree up to which items are opened when the DisplayMode property is set to 3 (OpenToLevel).

 

Default value: 1

 

Template

String

 

Defines the template used for detection and creation of bookmark trees. This property is not controlled via ActiveX and should be an empty string, which means current template. The AddBookmarkItem

function can be used to create current templates for this property.

 

Default value: empty string