GetPageElementEffectiveClipInfo
Content stream editing, Clipping paths
Description
Returns one flag describing the combined effective clipping region captured for an enumerated page element
Syntax
Delphi
Function TPDFlib.GetPageElementEffectiveClipInfo(ElementID, InfoIndex: Integer): Integer;Parameters
| ElementID | Opaque page-element handle |
|---|---|
| InfoIndex | 0 complete reconstructable chain, 1 bounds known, 2 bounds exactly represent the region, 3 region known empty |
Return value
1 when the selected flag is true, otherwise zero
Remarks
The exact region is the intersection of every component returned by the clip-path APIs, evaluated in order with each component's fill rule
Bounds remain useful for fast rejection when the region is non-rectangular; an exact-bounds value of zero means the rectangle is conservative rather than that the path data is incomplete
Completeness becomes zero when text outlines contribute to clipping because glyph outlines are not retained by page-element enumeration