GetPageElementEffectiveClipBound

Content stream editing, Clipping paths

Description

Returns one bound for the combined effective clipping region of an enumerated page element in default user space

Syntax

Delphi

Function TPDFlib.GetPageElementEffectiveClipBound(ElementID, BoundIndex: Integer): Double;

Parameters

ElementIDOpaque page-element handle
BoundIndex0 minimum x, 1 minimum y, 2 maximum x, 3 maximum y

Return value

The requested coordinate, or zero when the handle or selector is invalid or effective bounds are unknown

Remarks

The returned rectangle is the progressively intersected bound of the page boundary, path components and Form boundaries. Use

GetPageElementEffectiveClipInfo to distinguish unknown bounds, conservative non-rectangular bounds, exact rectangular regions and known-empty intersections