AddDocumentPart

Document parts, variable data, PDF 2.0

Description

Adds a child document part beneath an existing hierarchy part

Syntax

Delphi

Function TPDFlib.AddDocumentPart(ParentPartID, StartPage, EndPage: Integer): Integer;

DLL

int DLAddDocumentPart(int InstanceID, int ParentPartID, int StartPage, int EndPage);

ActiveX

Function PDFlib::AddDocumentPart(ParentPartID As Long, StartPage As Long, EndPage As Long) As Long

Parameters

ParentPartIDRoot or internal part identifier returned by this hierarchy
StartPage, EndPageInclusive one-based leaf range, or 0 and 0 to create an internal part

Return values

Returns the positive child part identifier on success, or 0 on invalid input

Remarks

A leaf range cannot overlap pages already assigned to another leaf, and leaf parts cannot receive children

Children are stored in bounded blocks so very large record batches do not require one monolithic PDF array

See also

SetDocumentPartPageRange, SetDocumentPartMetadata