Foxit PDF SDK
|
Public Member Functions | |
def | Redaction (document) |
Constructor, from a PDF document object. More... | |
def | Redaction (other) |
Constructor, with another redaction object. More... | |
def | Apply () |
Apply redaction in marked areas: remove the text or graphics under marked areas permanently. More... | |
def | IsEmpty () |
Check whether current object is empty or not. More... | |
def | MarkRedactAnnot (page, rects) |
Mark page contents (text object, image object, and path object) which are to be redacted. More... | |
def | StartApply (pause) |
Start to apply redaction in marked areas: remove the text or graphics under marked areas permanently. 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.
def FoxitPDFSDKPython3.Redaction.Redaction | ( | document | ) |
Constructor, from a PDF document object.
[in] | document | A valid PDF document object. |
def FoxitPDFSDKPython3.Redaction.Redaction | ( | other | ) |
Constructor, with another redaction object.
[in] | other | Another redaction object. |
def FoxitPDFSDKPython3.Redaction.Apply | ( | ) |
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 FoxitPDFSDKPython3.Redact.SetApplyFillColor .
def FoxitPDFSDKPython3.Redaction.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython3.Redaction.MarkRedactAnnot | ( | page, | |
rects | |||
) |
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:
Once function FoxitPDFSDKPython3.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. |
def FoxitPDFSDKPython3.Redaction.StartApply | ( | pause | ) |
Start to apply redaction in marked areas: remove the text or graphics under marked areas permanently.
This function is similar to function FoxitPDFSDKPython3.Redaction.Apply , but this function will return a progressive object which can be used to do the redaction progressively.
[in] | pause | A callback object which decides if the applying process should be paused. This can be null which means not to pause during the applying process. If this is not null, it should be a valid pause object implemented by user. |