THPDFPage.AddRedactAnnotation Method
Adds redact annotation data to the annotation and action workflow. The call creates or attaches the PDF-side object needed by later output, validation, signing, or page rendering steps
Declaration
procedure AddRedactAnnotation(Rectangle: TRect; const OverlayText: AnsiString= ''; const Contents: AnsiString= ''; Color: TColor= clBlack);Unit
HPDFDoc
Parameters
| Name | Purpose |
|---|---|
Rectangle | Page area or widget rectangle where the operation is applied |
OverlayText | Input used by AddRedactAnnotation |
Contents | Human-readable text stored in the PDF object, action, annotation, or structure element |
Color | Color component or color value used by the painting or resource operation |
Return value
This member does not return a value
Usage notes
- Use this API in the annotation and action workflow before the affected page, resource, field, or catalog object is finalised
- Keep object names, field names, resource names, and returned handles stable until the document is finalised
- Page-level changes affect subsequent operators on the same page; save and restore graphics state when a temporary setting should not leak