ExecutePageLifecycleAction method

Component: TPdf · Unit: PDFium

Runs one page-level open or close action on demand

Syntax

function ExecutePageLifecycleAction(PageNumber: Integer; Action: TPdfPageLifecycleAction; out ErrorMessage: string): Boolean;

Description

ExecutePageLifecycleAction executes the plaOpen or plaClose additional action of the page at one-based PageNumber and returns True when the action ran

ErrorMessage receives the failure reason when the result is False, for example when the policy disables lifecycle actions or the page has no such action

Remarks

PageNumber must identify a page of the active document
Use GetPageActionType and GetPageActionURI to inspect which actions a page declares before executing them

Example

if not Pdf1.ExecutePageLifecycleAction(3, plaOpen, Err) then
Log(Err);