DeletePageElementClipPath
Content stream editing, Clipping paths
Description
Deletes one exact editable component from an enumerated element's effective clipping intersection
Syntax
Delphi
Function TPDFlib.DeletePageElementClipPath(ElementID, ClipPathIndex: Integer): Integer;Parameters
| ElementID | Opaque page-element handle |
|---|---|
| ClipPathIndex | 1-based component index whose editable flag is returned by property 6 of GetPageElementClipPathInfo |
Return values
| 1 | The clipping component was deleted and all page-element handles were invalidated |
|---|---|
| 0 | The handle or index is invalid, the captured source changed or the component is read-only |
Remarks
For the usual W n or W* n sequence, the now-unused complete path object is removed
When the terminating operator also strokes or fills, only W or W* is removed so the original painting operation remains intact
Deleting an existing component expands the clipping region for every later consumer in the same graphics-state scope
On failure, LastErrorCode is 532 for invalid input, 533 for stale source or 534 for a read-only component