EndFormXObject

Page layout

Description

Completes the active Form XObject build and captures the temporary drawing surface as a reusable Form XObject handle. The temporary page is removed and the caller page that was selected before BeginFormXObject is restored

Syntax

Delphi

Function TPDFlib.EndFormXObject: Integer;

ActiveX

Function PDFlib::EndFormXObject() As Long

DLL

int DLEndFormXObject(int InstanceID);

Return values

0No Form XObject build was active or the capture could not be completed
>0A captured-page handle that can be placed with DrawCapturedPage or related captured-page APIs

Remarks

The returned handle uses the same captured-page resource path as CapturePageEx. It can be drawn repeatedly without replaying the original drawing commands

Call CancelFormXObject instead when the temporary drawing surface should be discarded

See also

BeginFormXObject, CancelFormXObject, DrawCapturedPage, SetCapturedPageTransparencyGroup