Foxit PDF SDK
FoxitPDFSDKPython3.Redaction Class Reference
Inheritance diagram for FoxitPDFSDKPython3.Redaction:
FoxitPDFSDKPython3.Base

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...
 

Detailed Description

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
FoxitPDFSDKPython3.Redact

Constructor & Destructor Documentation

◆ Redaction() [1/2]

def FoxitPDFSDKPython3.Redaction.Redaction (   document)

Constructor, from a PDF document object.

Parameters
[in]documentA valid PDF document object.
Note
If module "Redaction" is not defined in the license information which is used in function FoxitPDFSDKPython3.Library.Initialize , that means user has no right in using redaction related functions and this constructor will throw exception FoxitPDFSDKPython3.e_ErrNoRedactionModuleRight .

◆ Redaction() [2/2]

def FoxitPDFSDKPython3.Redaction.Redaction (   other)

Constructor, with another redaction object.

Parameters
[in]otherAnother redaction object.

Member Function Documentation

◆ Apply()

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 .

Returns
true means success, while false means failure.

◆ IsEmpty()

def FoxitPDFSDKPython3.Redaction.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ MarkRedactAnnot()

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.

Parameters
[in]pageA PDF page whose content will be marked.
[in]rectsSpecify 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 redact annotation object (along with a pop-up annotation by default), with default appearance:
apply fill color = black, border color = red, opacity = 1.0.

◆ StartApply()

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.

Parameters
[in]pauseA 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.
Returns
A progressive object. Please check the rate of current progress by function FoxitPDFSDKPython3.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython3.Progressive.Continue to continue the progress until the progress is finished.