ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > Page Editing Objects and Elements > HIG_PDE_CLIP

Handle to the PDE clip object. A clip is a list of elements containing a list of Paths and Texts that describe a clip state. Clips can be created and built up with PDE Clip methods. Any PDE Element object can have Clip associated with it. Clip objects can contain PDE Containers and PDE Groups to an arbitrary level of nesting. This allows PDE Containers to be used to mark clip objects.

PDE Groups inside PDE Clips that contain at least one PDE Text and no PDE Paths have a special meaning. All PDE Text objects contained in such a PDE Group are considered to be part of the same BT/ET block. This means that the union of these PDE Texts makes up a single clipping path, as opposed to the intersection of the PDE Texts.

See Section 5.3 in the PDF reference for more information about BT/ET block.


IG_PDE_clip_add_element Adds an element to a clip path.
IG_PDE_clip_clone Makes a deep copy of a PDE Clip object.
IG_PDE_clip_create Creates an empty clip object.
IG_PDE_clip_enumerate_elements For a given PDE Clip, enumerates all of the PDE Elements in a flattened manner.
IG_PDE_clip_get_element Gets an element from a clip object.
IG_PDE_clip_get_element_count Gets the number of top-level elements in a clip object.
IG_PDE_clip_remove_elements Removes one or more elements from a clip object.
Is this page helpful?
Yes No
Thanks for your feedback.