Redacting a PDF file allows user to hide sensitive information while keeping the document's formatting. This class can be used to mark page contents with redact annotations and apply redaction to permanently remove (redact) visible text and images from PDF documents to protect confidential information such as social security numbers.
- See also
- pdf::annots::Redact
Redact foxit.addon.Redaction.MarkRedactAnnot |
( |
PDFPage |
page, |
|
|
RectFArray |
rects |
|
) |
| |
|
inline |
Mark page contents (text object, image object, and path object) which are to be redacted.
This function is to add special marks (called redact annotation) to the specified rectangles areas, in order to redact page contents in these areas. Usually, the marked area has two appearance:
Normal appearance, which is used when the marked area is not interacting with the user. The border color (also known as stroke color) can be set by function pdf::annots::Annot::SetBorderColor. The fill color can be set by function pdf::annots::Redact::SetFillColor. The opcacity can be set by function pdf::annots::Markup::SetOpacity.
Rollover appearance, which is used when the user moves the cursor into the marked area without pressing the mouse button. The border color and fill color are the same and can be set by function pdf::annots::Redact::SetApplyFillColor.
Once function Redaction::Apply is called, all the page contents under these marked area will be removed permanently and these marked areas will keep their rollover appearance all the time.
- Parameters
-
page | A PDF page whose content will be marked.
|
rects | Specify areas in the page to be marked. It should not be an empty array. All the input rectangles will be treated as one redact annotation.
|
- Returns
- A annots::Redact object (along with a pop-up annotation by default), with default appearance:
apply fill color = black, border color = red, opacity = 1.0.