PDFium Delphi Component Docs

PageObjectClipPath method

Component: TPdf  ·  Unit: PDFium
Read the clip path that limits where one page object is allowed to paint

Syntax

function PageObjectClipPath(Index: Integer): TPdfClipPath;

IndexInteger. Zero-based index of the page object
ResultTPdfClipPath. Record whose Paths array holds one TPdfPathSegments array per sub-path of the clip. An empty array means the object is not clipped

Description

A clip path can consist of several sub-paths, so the result is an array of segment arrays. Each segment carries its type (move, line or Bezier), its point and whether it closes the sub-path - the same shape PathInfo returns for a drawn path

Coordinates are in PDF page units. Because the clip belongs to the graphics state that was active when the object was painted, it is reported per object rather than per page

An object with no clip yields an empty Paths array, which is a normal result and not an error

See Also

InsertClipPath, PathInfo, PageObjectInfo