GetPageElementClipPathCount

Content stream editing, Clipping paths

Description

Returns the number of clipping components in the effective intersection chain captured for an enumerated page element

Syntax

Delphi

Function TPDFlib.GetPageElementClipPathCount(ElementID: Integer): Integer;

Parameters

ElementIDOpaque handle returned by EnumPageElements or EnumeratePageElements

Return value

The component count, or zero when the handle is invalid

Remarks

The chain starts with the page boundary and then records every path, text or Form boundary intersected into the graphics-state clipping path

Path elements that establish clipping expose their state after the terminating paint or n operator; other elements expose the clipping state active when painting begins

Components are immutable and shared by graphics-state snapshots, so enumeration retains each path once while repeated scalar queries avoid reparsing content streams