Foxit PDF SDK
|
Public Member Functions | |
Redaction (PDFDoc document) | |
Constructor, from a PDF document object. More... | |
Redaction (Redaction other) | |
Constructor, with another redaction object. More... | |
bool | Apply () |
Apply redaction in marked areas: remove the text or graphics under marked areas permanently. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
Redact | MarkRedactAnnot (PDFPage page, RectFArray rects) |
Mark page contents (text object, image object, and path object) which are to be redacted. More... | |
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.
|
inline |
Constructor, from a PDF document object.
[in] | document | A valid PDF document object. |
|
inline |
Constructor, with another redaction object.
[in] | other | Another redaction object. |
|
inline |
Apply redaction in marked areas: remove the text or graphics under marked areas permanently.
Once this functions is called, all the marked page content(text object, image object, and path object) in the document will be removed permanently. All the redact annotations which specify marked areas will be removed (with their pop-up annotations) and these marked areas will be filled by the color specified by pdf.annots.Redact.SetApplyFillColor .
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
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 pdf.annots.Annot.SetBorderColor . The fill color can be set by pdf.annots.Redact.SetFillColor . The opcacity can be set by 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 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.
[in] | page | A PDF page whose content will be marked. |
[in] | 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. |