TPDFlibMergeOutlineEvent

Data Types

Description

TPDFlibMergeOutlineEvent represents the method signature for the event handler invoked during outline (bookmark) tree merges. It enables application code to rename or exclude bookmarks dynamically.

Syntax

Delphi

type TPDFlibMergeOutlineEvent = procedure(Sender: TObject; SourceDocIndex: Integer; var Title: WideString; var Skip: Boolean) of object;

Parameters

SenderThe TPDFlib object triggering the event callback.
SourceDocIndexThe 1-based index of the source PDF document in the merge queue.
TitleA reference to the bookmark's title string. Modify this value to rewrite the bookmark name in the merged destination.
SkipA reference to a boolean flag. Set this parameter to True to discard this outline node and its entire sub-tree from the merged document outline.

See also

OnMergeOutline, MergeDocument