Foxit PDF SDK

Public Member Functions | Static Public Attributes | List of all members
FoxitPDFSDKPython3.PDFPage Class Reference
Inheritance diagram for FoxitPDFSDKPython3.PDFPage:

## Public Member Functions
def | PDFPage (other)
| Constructor, with parent class object. More...
def | AddAnnot (annot_dict)
| Add an annotation (by a valid annotation dictionary) to current PDF page. More...
def | AddAnnot (type, rect)
| Add an annotation to current PDF page. More...
def | AddImage (image, frame_index, position, width, height, auto_generate_content)
| Add an image to current page. More...
def | AddImageFromFilePath (file_path, position, width, height, auto_generate_content)
| Add an image to current page from file path. More...
def | AddSignature (rect)
| Add an ordinary signature to PDF page. More...
def | AddSignature (rect, field_name)
| Add an ordinary signature to PDF page. More...
def | AddSignature (rect, field_name, signature_type, to_check_permission)
| Add a signature to PDF page. More...
def | AddSignatureWithExistedVDict (rect, field_name, signature_type, to_check_permission, existed_signature)
| Add a signature to PDF page with the existed "V" dictionary in the specific signature. More...
def | AddText (text, rect, style, matrix, is_each_text, disable_embed_font)
| Add text to current page. More...
def | AddText (text, rect, style, rotation, rotate_point, disable_embed_font)
| Add text to current page. More...
def | CalcContentBBox (mode)
| Calculate the content area of PDF page. More...
def | CalculateNewRectForText (text, rect, style, rotation, rotate_point, disable_embed_font)
| Calculate the new text rectangle. More...
def | ClearRenderCache ()
| Clear render cache. More...
def | Flatten (for_display, options)
| Flatten current PDF page: annotations or form fields may be made to be a part of the page contents according to specified options. More...
def | FlattenAnnot (annot)
| Flatten an annotation: the annotation is made to be a part of the page contents and be removed then. More...
def | GetAnnot (index)
| Get an annotation by index. More...
def | GetAnnotAtDevicePoint (position, tolerance, matrix)
| Get the annotation at a specified position, in device coordinate system. More...
def | GetAnnotAtPoint (position, tolerance)
| Get the annotation at a specified position, in [PDF coordinate system] (). More...
def | GetAnnotCount ()
| Get the count of annotations. More...
def | GetAnnots ()
| Get the PDF array of "Annots". More...
def | GetAnnotsAtDevicePoint (position, tolerance, matrix)
| Get all the annotations at a specified position, in device coordinate system. More...
def | GetAnnotsAtPoint (position, tolerance)
| Get all the annotations at a specified position, in [PDF coordinate system] (). More...
def | GetBox (box_type)
| Get page box. More...
def | GetContents ()
| Get the PDF object of "Contents". More...
def | GetDict ()
| Get the page dictionary. More...
def | GetDisplayMatrix (left, top, width, height, rotate)
| Get the display matrix of PDF page, from [PDF coordinate system] () to targeted device coordinate system. More...
def | GetDocument ()
| Get the PDF document, to which current PDF page belongs. More...
def | GetGraphicsObjectAtDevicePoint (point, tolerance, matrix, filter)
| Get the topmost graphics object in specified point in device coordinate system, with specified type filter. More...
def | GetGraphicsObjectAtPoint (point, tolerance, filter)
| Get the topmost graphics object in specified point, with specified type filter. More...
def | GetGraphicsObjectAtRectangle (rect, filter)
| Get the topmost graphics object whose rectangle interasects with a specified rectangle, with specified type filter. More...
def | GetGraphicsObjectsAtDevicePoint (point, tolerance, matrix, filter)
| Get all the graphics objects in specified point in device coordinate system, with specified type filter. More...
def | GetGraphicsObjectsAtPoint (point, tolerance, filter)
| Get all the graphics objects in specified point, with specified type filter. More...
def | GetGraphicsObjectsAtRectangle (rect, filter)
| Get all the graphics objects whose rectangles intersect with a specified rectangle, with specified type filter. More...
def | GetHeight ()
| Get the page height (unit is 1/72 inch). More...
def | GetIndex ()
| Get page index. More...
def | GetInheritedAttribute (attruibute_name)
| Get the PDF object for specified attribute which may be inherited from the ancestor node in the page tree. More...
def | GetResources ()
| Get the PDF dictionary of "Resources". More...
def | GetRotation ()
| Get the page rotation. More...
def | GetSuggestedRect (render_result, render_matrix, point)
| Get the suggested rectangle (in [PDF coordinate system] ()) for a point (in [PDF coordinate system] ()) based on the rendering result bitmap. More...
def | GetThumb ()
| Get the PDF stream of "Thumb". More...
def | GetUserUnitSize ()
| Get the user unit. More...
def | GetWidth ()
| Get the page width (unit is 1/72 inch). More...
def | HasTransparency ()
| Check whether current PDF page has transparency or not. More...
def | HasWatermark ()
| Check whether the current page has any watermark (not including Foxit PDF SDK trial watermark). More...
def | IsParsed ()
| Check if current page has been parsed or not. More...
def | IsScanned ()
| Check whether current PDF page is scanned page or not. More...
def | LoadThumbnail ()
| Load the thumbnail bitmap. More...
def | MoveAnnotToFirst (annot)
| Change specified annotation to be the first one of all annotations. More...
def | MoveAnnotToLast (annot)
| Change specified annotation to be the last one of all annotations. More...
def | MoveAnnotToNext (annot)
| Exchange the indexes of current annotation and its next annotation. More...
def | MoveAnnotToPrev (annot)
| Exchange the indexes of current annotation and its previous annotation. More...
def | Normalize ()
| Transform current PDF page by undoing any rotation and removing the offset to the page's "CropBox". More...
def | RemoveAllWatermarks ()
| Remove all watermarks. More...
def | RemoveAnnot (annot)
| Remove an annotation. More...
def | SetAnnotGroup (annot_array, header_index)
| Group all the input markup annotations together. More...
def | SetBox (box_type, box)
| Set page box. More...
def | SetClipRect (clip_rect)
| Set clip rectangle for all graphics objects on current PDF page. More...
def | SetRotation (rotate)
| Set page rotation. More...
def | SetSize (size)
| Set page size type. More...
def | SetSize (width, height)
| Set page width and height. More...
def | SetThumbnail (thumbnail)
| Set page thumbnail. More...
def | SetUserUnitSize (user_unit)
| Set the user unit. More...
def | SplitTextsInRectangle (rect, split_step)
| Split text objects whose rectangles (in [PDF coordinate system] ()) intersect with a specified rectangle (in [PDF coordinate system] ()), and further split the intersecting portion based on split_step. More...
def | StartParse (flags, pause, is_reparse)
| Start to parse current page. More...
def | Transform (matrix, need_transform_clip_path, need_transform_annotations)
| Transform a PDF page, including annotations and form fields on the page. More...
def | UpdateAnnotList ()
| Update the annotation list. More...
Public Member Functions inherited from FoxitPDFSDKPython3.GraphicsObjects
def | GraphicsObjects (other)
| Constructor, with another GraphicsObjects object. More...
def | GenerateContent ()
| Generate contents of current graphics objects. More...
def | GenerateContent (text_merge_option)
| Generate contents of current graphics objects. More...
def | GetFirstGraphicsObjectPosition (filter)
| Get the position of first graphics object in graphics object list, based on type filter. More...
def | GetGraphicsObject (index)
| Get a graphics object by index. More...
def | GetGraphicsObjectCount ()
| Get the count of graphics objects in graphics object list. More...
def | GetGraphicsObjectIndex (graphics_object)
| Get the index of a specified graphics object in graphics object list. More...
def | GetGraphicsObjectPosition (graphics_object)
| Get the position of the specified graphics object. More...
def | GetLastGraphicsObjectPosition (filter)
| Get the position of last graphics object in graphics object list, based on type filter. More...
def | GetNextGraphicsObjectPosition (position, filter)
| Get the position of next graphics object in graphics object list, based on type filter and specified current position. More...
def | GetPrevGraphicsObjectPosition (position, filter)
| Get the position of previous graphics object in graphics object list, based on type filter and specified current position. More...
def | InsertGraphicsObject (position_insert_after, graphics_object)
| Insert a graphics object after the specified position. More...
def | IsEmpty ()
| Check whether current object is empty or not. More...
def | MoveGraphicsObjectByPosition (current_position, position_move_after)
| Move a graphics object from a position to another position. More...
def | RemoveGraphicsObject (graphics_object)
| Remove a graphics object. More...
def | RemoveGraphicsObjectByPosition (position)
| Remove a graphics object by position. More...

## Static Public Attributes
| e_ArtBox = _fsdk.PDFPage_e_ArtBox
| Art Box for page boundary. More...
| e_BleedBox = _fsdk.PDFPage_e_BleedBox
| Bleed Box for page boundary. More...
| e_CalcContentsBox = _fsdk.PDFPage_e_CalcContentsBox
| Calculate margin according to bounding box of all contents.
| e_CalcDetection = _fsdk.PDFPage_e_CalcDetection
| Calculate margin by detecting paths or images.
| e_CropBox = _fsdk.PDFPage_e_CropBox
| Crop Box for page boundary. More...
| e_FlattenAll = _fsdk.PDFPage_e_FlattenAll
| Flatten all contents of a PDF page.
| e_FlattenNoAnnot = _fsdk.PDFPage_e_FlattenNoAnnot
| Flatten a PDF page without annotations.
| e_FlattenNoFormControl = _fsdk.PDFPage_e_FlattenNoFormControl
| Flatten a PDF page without form controls.
| e_MediaBox = _fsdk.PDFPage_e_MediaBox
| Media Box for page boundary. More...
| e_ParsePageNormal = _fsdk.PDFPage_e_ParsePageNormal
| Parsing flag for normal mode, which means to parse all the contents in a PDF page.
| e_ParsePageTextOnly = _fsdk.PDFPage_e_ParsePageTextOnly
| Parsing flag for text-only mode.
| e_SizeA2 = _fsdk.PDFPage_e_SizeA2
| Page size: A2.
| e_SizeA3 = _fsdk.PDFPage_e_SizeA3
| Page size: A3.
| e_SizeA4 = _fsdk.PDFPage_e_SizeA4
| Page size: A4.
| e_SizeA5 = _fsdk.PDFPage_e_SizeA5
| Page size: A5.
| e_SizeA6 = _fsdk.PDFPage_e_SizeA6
| Page size: A6.
| e_SizeB2 = _fsdk.PDFPage_e_SizeB2
| Page size: B2.
| e_SizeB3 = _fsdk.PDFPage_e_SizeB3
| Page size: B3.
| e_SizeB4 = _fsdk.PDFPage_e_SizeB4
| Page size: B4.
| e_SizeB5 = _fsdk.PDFPage_e_SizeB5
| Page size: B5.
| e_SizeB6 = _fsdk.PDFPage_e_SizeB6
| Page size: B6.
| e_SizeLegal = _fsdk.PDFPage_e_SizeLegal
| Page size: legal.
| e_SizeLetter = _fsdk.PDFPage_e_SizeLetter
| Page size: letter.
| e_TrimBox = _fsdk.PDFPage_e_TrimBox
| Trim Box for page boundary. More...
Static Public Attributes inherited from FoxitPDFSDKPython3.GraphicsObjects
| e_TextMergeBTET = _fsdk.GraphicsObjects_e_TextMergeBTET
| Merge consecutive BTETs as a new one. More...
| e_TextMergeNone = _fsdk.GraphicsObjects_e_TextMergeNone
| No text merge.
| e_TextMergeTJY = _fsdk.GraphicsObjects_e_TextMergeTJY
| Merge consecutive text-showing operators with equal y coordinates.

## Detailed Description

A PDF page is defined in PDF coordinate system which uses the lower-left corner of the page as origin point (0, 0).
Usually, a PDF page object is retrieved from a PDF document by function FoxitPDFSDKPython3.PDFDoc.GetPage . For most case, a PDF page should be parsed first and then be used. Function FoxitPDFSDKPython3.PDFPage.IsParsed can be used to judge whether the PDF page has been parsed or not. For a unparsed page, please use function FoxitPDFSDKPython3.PDFPage.StartParse to parse it.
This class offers functions to get/set data of a PDF page, such as page width/height, page rotation, display matrix and so on. Also, this class offers functions to retrieve PDF annotations:

- To get a PDF annotation, use function FoxitPDFSDKPython3.PDFPage.GetAnnot , FoxitPDFSDKPython3.PDFPage.GetAnnotAtPoint , or FoxitPDFSDKPython3.PDFPage.GetAnnotAtDevicePoint .
- To add a new PDF annotation, use function FoxitPDFSDKPython3.PDFPage.AddAnnot .
- To remove a PDF annotation, use function FoxitPDFSDKPython3.PDFPage.RemoveAnnot .

Class FoxitPDFSDKPython3.PDFPage is derived from class FoxitPDFSDKPython3.GraphicsObjects , so class PDFPage also offers functions to retrieve PDF graphics objects:

- To get a PDF graphics object, use functions FoxitPDFSDKPython3.GraphicsObjects.GetFirstGraphicsObjectPosition , FoxitPDFSDKPython3.GraphicsObjects.GetNextGraphicsObjectPosition , FoxitPDFSDKPython3.GraphicsObjects.GetLastGraphicsObjectPosition , FoxitPDFSDKPython3.GraphicsObjects.GetPrevGraphicsObjectPosition and FoxitPDFSDKPython3.GraphicsObjects.GetGraphicsObject (these functions are inherited from parent class), or FoxitPDFSDKPython3.PDFPage.GetGraphicsObjectAtPoint .
- To insert a PDF graphics object, use function FoxitPDFSDKPython3.GraphicsObjects.InsertGraphicsObject (inherited from parent class).
- To remove a PDF graphics object, use functions FoxitPDFSDKPython3.GraphicsObjects.RemoveGraphicsObjectByPosition or FoxitPDFSDKPython3.GraphicsObjects.RemoveGraphicsObject (these functions are inherited from parent class).

This class object can also be used to construct objects of other classes in order to access specified information in PDF page:

- To access text content in PDF page, please construct a TextPage with PDF page object.
- To do reflowing, please construct a ReflowPage with PDF page object.
- To access additional actions, please construct an FoxitPDFSDKPython3.AdditionalAction object with PDF page object.
- To manage the tab order of annotations in PDF page, please construct a TabOrderMgr with PDF page object.

See also
  PDFDoc
  GraphicsObjects
  TextPage
  ReflowPage
  FoxitPDFSDKPython3.AdditionalAction
  TabOrderMgr

## Constructor & Destructor Documentation

## ◆ PDFPage()

def FoxitPDFSDKPython3.PDFPage.PDFPage | ( |  | other | ) |

Constructor, with parent class object.

Parameters

  [in] | other | Parent class object.

## Member Function Documentation

## ◆ AddAnnot() [1/2]

def FoxitPDFSDKPython3.PDFPage.AddAnnot | ( |  | annot_dict | ) |

Add an annotation (by a valid annotation dictionary) to current PDF page.

Parameters

  [in] | annot_dict | An valid annotation dictionary which is to be added as an annotation to current PDF page.

Returns
  The newly created annotation object.

## ◆ AddAnnot() [2/2]

def FoxitPDFSDKPython3.PDFPage.AddAnnot | ( |  | type,
|  |  | rect
| ) |  |

Add an annotation to current PDF page.

Currently, this function can support to add most annotation types except:
Widget, Sound, Movie, PrinterMark, TrapNet, Watermark, 3D, PSInk, Redact.
Attention:

- Widget annotation are used to represent the appearance of a form field, including signature field:
  For signature field, function FoxitPDFSDKPython3.PDFPage.AddSignature can be called to add a new signature object.
  For other types of form field, function FoxitPDFSDKPython3.Form.AddControl can be called to add a new form field (with form control).
- PSInk annotation should be converted from a PSI object by function FoxitPDFSDKPython3.PSI.ConvertToPDFAnnot .
- Redact annotation should be added to mark areas in PDF page by function FoxitPDFSDKPython3.Redaction.MarkRedactAnnot .
- For supported annotations types, if user does not set any properties of the newly created annotation (except the required properties) and directly calls function FoxitPDFSDKPython3.Annot.ResetAppearanceStream , default appearance will be used. Please refer to comment of concrete annotation class for more details of their own default appearance.

Parameters

  [in] | type | The type of annotation to be added. Please refer to values starting from FoxitPDFSDKPython3.Annot.e_Note and this should be one of these values except FoxitPDFSDKPython3.Annot.e_PSInk , FoxitPDFSDKPython3.Annot.e_Sound , FoxitPDFSDKPython3.Annot.e_Movie , FoxitPDFSDKPython3.Annot.e_Widget , FoxitPDFSDKPython3.Annot.e_PrinterMark , FoxitPDFSDKPython3.Annot.e_TrapNet , FoxitPDFSDKPython3.Annot.e_Watermark , FoxitPDFSDKPython3.Annot.e_3D .
  [in] | rect | Rectangle of the new annotation. For annotation in following type, they needs a valid rectangle when being added. So for them, rect should be valid: FoxitPDFSDKPython3.Annot.e_Note , FoxitPDFSDKPython3.Annot.e_Link , FoxitPDFSDKPython3.Annot.e_Square , FoxitPDFSDKPython3.Annot.e_Circle , FoxitPDFSDKPython3.Annot.e_FreeText , FoxitPDFSDKPython3.Annot.e_Stamp , FoxitPDFSDKPython3.Annot.e_Caret , FoxitPDFSDKPython3.Annot.e_FileAttachment , FoxitPDFSDKPython3.Annot.e_Screen . For rest supported annotation types, their rectangle will be updated when other required properties of them have been set. So for these annotations, rect can be an empty rectangle. If an invalid rectangle is passed to rect, an empty rectangle will be used instead.

Returns
  The newly created annotation object.

## ◆ AddImage()

def FoxitPDFSDKPython3.PDFPage.AddImage | ( |  | image,
|  |  | frame_index,
|  |  | position,
|  |  | width,
|  |  | height,
|  |  | auto_generate_content
| ) |  |

Add an image to current page.

If the type of image is FoxitPDFSDKPython3.Image.e_JPG , the image should be kept valid until the related document is closed.

Parameters

  [in] | image | An image. One of its frames will be set to current page. This image contains at least one frame and the image type should not be FoxitPDFSDKPython3.Image.e_Unknown .
  [in] | frame_index | Frame index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython3.Image.GetFrameCount .
  [in] | position | A specified position which is the bottom left corner of image object, in [PDF coordinate system] ().
  [in] | width | The width which is used for the image to set into page (unit is 1/72 inch). The value should be larger than 0.
  [in] | height | The height which is used for the image to set into page (unit is 1/72 inch). The value should be larger than 0.
  [in] | auto_generate_content | true means to generate content internally. When using false, user should ensure to call function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent after adding image. Please refer to function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent for more details. Default value: true.

Returns
  true means success, while false means failure.

## ◆ AddImageFromFilePath()

def FoxitPDFSDKPython3.PDFPage.AddImageFromFilePath | ( |  | file_path,
|  |  | position,
|  |  | width,
|  |  | height,
|  |  | auto_generate_content
| ) |  |

Add an image to current page from file path.

If input image (specified by file path) has more than one frame, only the first frame will be added to current page acquiescently.

Parameters

  [in] | file_path | A full path of an existing image file. It should not be an empty string.
  [in] | position | A specified position which is the bottom left corner of image object, in [PDF coordinate system] ().
  [in] | width | The width which is used for the image to set into page. The value should be larger than 0.
  [in] | height | The height which is used for the image to set into page. The value should be larger than 0.
  [in] | auto_generate_content | true means to generate content internally. When using false, user should ensure to call function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent after adding image. Please refer to function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent for more details. Default value: true.

Returns
  true means success, while false means failure.

## ◆ AddSignature() [1/3]

def FoxitPDFSDKPython3.PDFPage.AddSignature | ( |  | rect | ) |

Add an ordinary signature to PDF page.

For a new ordinary signature, its filter will be "Adobe.PPKLite" and sub filter will be "adbe.pkcs7.detached" by default. Please refer to class Signature for more details about signature's filter and sub-filter.
Before signing the new signature, user can also call setting functions of class Signature to set other information used for signing and signed appearance.

Parameters

  [in] | rect | Rectangle position for the new signature, in [PDF coordinate system] (). It should be a valid rectangle in [PDF coordinate system] ().

Returns
  The newly added signature object.

## ◆ AddSignature() [2/3]

def FoxitPDFSDKPython3.PDFPage.AddSignature | ( |  | rect,
|  |  | field_name
| ) |  |

Add an ordinary signature to PDF page.

For a new ordinary signature, its filter will be "Adobe.PPKLite" and sub filter will be "adbe.pkcs7.detached" by default. Please refer to class Signature for more details about signature's filter and sub-filter.
Before signing the new signature, user can also call setting functions of class Signature to set other information used for signing and signed appearance.

Parameters

  [in] | rect | Rectangle position for the new signature, in [PDF coordinate system] (). It should be a valid rectangle in [PDF coordinate system] ().
  [in] | field_name | The signature field name. This can be an empty string.

Returns
  The newly added signature object.

## ◆ AddSignature() [3/3]

def FoxitPDFSDKPython3.PDFPage.AddSignature | ( |  | rect,
|  |  | field_name,
|  |  | signature_type,
|  |  | to_check_permission
| ) |  |

Add a signature to PDF page.

For a new ordinary signature, its filter will be "Adobe.PPKLite" and sub filter will be "adbe.pkcs7.detached" by default. For a new time stamp signature, its filter will be "Adobe.PPKLite" and sub filter will be "ETSI.RFC3161" by default. Please refer to class Signature for more details about signature's filter and sub-filter.
Before signing the new signature, user can also call setting functions of class Signature to set other information used for signing and signed appearance.

Parameters

  [in] | rect | Rectangle position for the new signature, in [PDF coordinate system] (). If parameter signature_type is FoxitPDFSDKPython3.Signature.e_SignatureTypeTimeStamp , this rectangle will be ignored; otherwise, this should be a valid rectangle in [PDF coordinate system] ().
  [in] | field_name | The signature field name. This can be an empty string.
  [in] | signature_type | Signature type. Please refer to values starting from FoxitPDFSDKPython3.Signature.e_SignatureTypeOrdinary and this should be one of these values.
  [in] | to_check_permission | A boolean value to decide whether Foxit PDF SDK should check PDF document's permission before adding signature: true means Foxit PDF SDK should check document permission to decide if adding signature is allowed, while false means Foxit PDF SDK should not check document permission before adding signature. When this parameter is false, user should ensure to check document permission to check if adding signature is allowed. Default value: true.

Returns
  The newly added signature object.

## ◆ AddSignatureWithExistedVDict()

def FoxitPDFSDKPython3.PDFPage.AddSignatureWithExistedVDict | ( |  | rect,
|  |  | field_name,
|  |  | signature_type,
|  |  | to_check_permission,
|  |  | existed_signature
| ) |  |

Add a signature to PDF page with the existed "V" dictionary in the specific signature.

For a new ordinary signature, its filter will be "Adobe.PPKLite" and sub filter will be "adbe.pkcs7.detached" by default. For a new time stamp signature, its filter will be "Adobe.PPKLite" and sub filter will be "ETSI.RFC3161" by default. Please refer to class Signature for more details about signature's filter and sub-filter.
Before signing the new signature, user can also call setting functions of class Signature to set other information used for signing and signed appearance. After sharing the V dictionary, any changes to the entries related to the V dictionary will simultaneously affect the signature's appearance of all signagures shared V dictionaries.

Parameters

  [in] | rect | Rectangle position for the new signature, in [PDF coordinate system] (). If parameter signature_type is FoxitPDFSDKPython3.Signature.e_SignatureTypeTimeStamp , this rectangle will be ignored; otherwise, this should be a valid rectangle in [PDF coordinate system] ().
  [in] | field_name | The signature field name. This can be an empty string.
  [in] | signature_type | Signature type. Please refer to values starting from FoxitPDFSDKPython3.Signature.e_SignatureTypeOrdinary and this should be one of these values.
  [in] | to_check_permission | A boolean value to decide whether Foxit PDF SDK should check PDF document's permission before adding signature: true means Foxit PDF SDK should check document permission to decide if adding signature is allowed, while false means Foxit PDF SDK should not check document permission before adding signature. When this parameter is false, user should ensure to check document permission to check if adding signature is allowed. Default value: true.
  [in] | existed_signature | The signature whose "V" dictionary will be used in the newly added signature.

Returns
  The newly added signature object.

## ◆ AddText() [1/2]

def FoxitPDFSDKPython3.PDFPage.AddText | ( |  | text,
|  |  | rect,
|  |  | style,
|  |  | matrix,
|  |  | is_each_text,
|  |  | disable_embed_font
| ) |  |

Add text to current page.

The text wraps around if it is too long to fit the rectangle.

Parameters

  [in] | text | Content of the new text string. This should not be an empty string.
  [in] | rect | The box rectangle, in [PDF coordinate system] ().
  [in] | style | Style data used for the new text string.
  [in] | matrix | The transformation matrix used for adding text block.
  [in] | is_each_text | A boolean value indicating whether to apply the transformation matrix individually to each text object within the text block.true means to use individual matrix for each text object, while false means to use the same matrix for the entire text block.
  [in] | disable_embed_font | A boolean value which indicates whether to disable embed font. true means to disable embed font, while false means not to.

Returns
  true means success, while false means failure.

Note
  When this function succeeds, function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent should be called. Please refer to function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent for more details.

## ◆ AddText() [2/2]

def FoxitPDFSDKPython3.PDFPage.AddText | ( |  | text,
|  |  | rect,
|  |  | style,
|  |  | rotation,
|  |  | rotate_point,
|  |  | disable_embed_font
| ) |  |

Add text to current page.

The text wraps around if it is too long to fit the rectangle.

Parameters

  [in] | text | Content of the new text string. This should not be an empty string.
  [in] | rect | The box rectangle, in [PDF coordinate system] ().
  [in] | style | Style data used for the new text string.
  [in] | rotation | The rotation value for the new text string.
  [in] | rotate_point | The rotation reference point. Please refer to values starting from FoxitPDFSDKPython3.e_RotationPointCenter and this should be one of these values.
  [in] | disable_embed_font | A boolean value which indicates whether to disable embed font. true means to disable embed font, while false means not to.

Returns
  The rectangle for the content of the text block.

Note
  When this function succeeds, function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent should be called. Please refer to function FoxitPDFSDKPython3.GraphicsObjects.GenerateContent for more details.

## ◆ CalcContentBBox()

def FoxitPDFSDKPython3.PDFPage.CalcContentBBox | ( |  | mode | ) |

Calculate the content area of PDF page.

Before using this function, please ensure current page has been parsed.

Parameters

  [in] | mode | Calculation mode. It should be one of following values: FoxitPDFSDKPython3.PDFPage.e_CalcContentsBox means to calculate margin according to bounding box of all contents. FoxitPDFSDKPython3.PDFPage.e_CalcDetection means to calculate margin by detecting paths or images.

Returns
  The minimal rectangle which contains the visible page content.

## ◆ CalculateNewRectForText()

def FoxitPDFSDKPython3.PDFPage.CalculateNewRectForText | ( |  | text,
|  |  | rect,
|  |  | style,
|  |  | rotation,
|  |  | rotate_point,
|  |  | disable_embed_font
| ) |  |

Calculate the new text rectangle.

Parameters

  [in] | text | Content of the new text string. This should not be an empty string.
  [in] | rect | The box rectangle, in [PDF coordinate system] ().
  [in] | style | Style data used for the new text string.
  [in] | rotation | The rotation value for the new text string.
  [in] | rotate_point | The rotation reference point. Please refer to values starting from FoxitPDFSDKPython3.e_RotationPointCenter and this should be one of these values.
  [in] | disable_embed_font | A boolean value which indicates whether to disable embed font. true means to disable embed font, while false means not to.

Returns
  The rectangle for the content of the text block.

## ◆ ClearRenderCache()

def FoxitPDFSDKPython3.PDFPage.ClearRenderCache | ( |  | ) |

Clear render cache.

Returns
  None.

## ◆ Flatten()

def FoxitPDFSDKPython3.PDFPage.Flatten | ( |  | for_display,
|  |  | options
| ) |  |

Flatten current PDF page: annotations or form fields may be made to be a part of the page contents according to specified options.

Annotation flag can decide if an annotation can be displayed or if an annotation can be printed. This also affects the flattened result:

- If the flattened result is used for displaying, only annotations which can be displayed will be flattened to be a part of page contents.
- If the flattened result is used for printing, only annotations which can be printed will be flattened to be a part of page contents.

Form field's appearance is represents by widget annotation which is a kind of annotation and treated as form control in Foxit PDF SDK. So annotation flag affects a form field as well when a form field is to be flattened. For more details about annotation flag, please refer to values starting from FoxitPDFSDKPython3.Annot.e_FlagInvisible and Section 8.4.2 "Annotation Flags" in <PDF Reference 1.7>.
After an annotation or a form field is flattened, it will not be an annotation or a form field any more. After flattening current page successfully, user should re-parse this page by function FoxitPDFSDKPython3.PDFPage.StartParse .

Parameters

  [in] | for_display | Decide the purpose of the flattened result: true means the flatten result is used for display only, and false means the flatten result is used for print only.
  [in] | options | The flatten options. Please refer to values starting from FoxitPDFSDKPython3.PDFPage.e_FlattenAll and this should one or a combination of them. Specially, if FoxitPDFSDKPython3.PDFPage.e_FlattenNoAnnot and FoxitPDFSDKPython3.PDFPage.e_FlattenNoFormControl are used together, that means nothing is to be flatten to page and this function will return true directly. Default value: FoxitPDFSDKPython3.PDFPage.e_FlattenAll .

Returns
  true means current page is flattened successfully, while false means failure.

## ◆ FlattenAnnot()

def FoxitPDFSDKPython3.PDFPage.FlattenAnnot | ( |  | annot | ) |

Flatten an annotation: the annotation is made to be a part of the page contents and be removed then.

After flattening the annotation successfully, user should re-parse this page by function FoxitPDFSDKPython3.PDFPage.StartParse .

Parameters

  [in] | annot | An annotation to be flattened and removed.

Returns
  true means success, while false means failure.

## ◆ GetAnnot()

def FoxitPDFSDKPython3.PDFPage.GetAnnot | ( |  | index | ) |

Get an annotation by index.

Parameters

  [in] | index | Annotation index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython3.PDFPage.GetAnnotCount .

Returns
  An annotation object.

## ◆ GetAnnotAtDevicePoint()

def FoxitPDFSDKPython3.PDFPage.GetAnnotAtDevicePoint | ( |  | position,
|  |  | tolerance,
|  |  | matrix
| ) |  |

Get the annotation at a specified position, in device coordinate system.

If there are several annotations in this specified position, this function will always return the topmost annotation. Annotations with flag FoxitPDFSDKPython3.Annot.e_FlagNoView or FoxitPDFSDKPython3.Annot.e_FlagHidden or FoxitPDFSDKPython3.Annot.e_FlagInvisible will not be retrieved by this function.If the returned annotation has a flag FoxitPDFSDKPython3.Annot.e_FlagReadOnly ,it cannot be modified.

Parameters

  [in] | position | The specified position, in device coordinate system.
  [in] | tolerance | Tolerance value. Valid range: 0.0f to 30.0f.
  [in] | matrix | The transformation matrix. Usually this is returned by function FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix . If this is null, current function will have the same feature as function FoxitPDFSDKPython3.PDFPage.GetAnnotAtPoint . Default value: null.

Returns
  An annotation object. If the return value of function FoxitPDFSDKPython3.Annot.IsEmpty for the returned annotation object is true, that means no PDF annotation can be found.

## ◆ GetAnnotAtPoint()

def FoxitPDFSDKPython3.PDFPage.GetAnnotAtPoint | ( |  | position,
|  |  | tolerance
| ) |  |

Get the annotation at a specified position, in [PDF coordinate system] ().

If there are several annotations in this specified position, this function will always return the topmost annotation. Annotations with flag FoxitPDFSDKPython3.Annot.e_FlagNoView or FoxitPDFSDKPython3.Annot.e_FlagHidden or FoxitPDFSDKPython3.Annot.e_FlagInvisible will not be retrieved by this function. If the returned annotation has a flag FoxitPDFSDKPython3.Annot.e_FlagReadOnly ,it cannot be modified.

Parameters

  [in] | position | The specified position, in [PDF coordinate system] ().
  [in] | tolerance | Tolerance value. Valid range: 0.0f to 30.0f.

Returns
  An annotation object. If the return value of function FoxitPDFSDKPython3.Annot.IsEmpty for the returned annotation object is true, that means no PDF annotation can be found.

## ◆ GetAnnotCount()

def FoxitPDFSDKPython3.PDFPage.GetAnnotCount | ( |  | ) |

Get the count of annotations.

Returns
  The count of annotations.

## ◆ GetAnnots()

def FoxitPDFSDKPython3.PDFPage.GetAnnots | ( |  | ) |

Get the PDF array of "Annots".

Note
  Please refer to "TABLE 3.27 Entries in a page object" in <PDF Reference 1.7> P147 for more details.

Returns
  The PDF array of "Annots". If there is no "Annots" entry or any error occurs, this function will return null.

## ◆ GetAnnotsAtDevicePoint()

def FoxitPDFSDKPython3.PDFPage.GetAnnotsAtDevicePoint | ( |  | position,
|  |  | tolerance,
|  |  | matrix
| ) |  |

Get all the annotations at a specified position, in device coordinate system.

In one specified position, there may exist several annotations. This function can be used to retrieve all these annotations in the specified position. Annotations with flag FoxitPDFSDKPython3.Annot.e_FlagNoView or FoxitPDFSDKPython3.Annot.e_FlagHidden or FoxitPDFSDKPython3.Annot.e_FlagInvisible will not be retrieved by this function.
If the return annotation object of function FoxitPDFSDKPython3.AnnotArray.GetAt for the returned annotation array object has flag FoxitPDFSDKPython3.Annot.e_FlagReadOnly , that means the annotation cannot be modified.

Parameters

  [in] | position | The specified position, in device coordinate system.
  [in] | tolerance | Tolerance value. Valid range: 0.0f to 30.0f.
  [in] | matrix | The transformation matrix. Usually this is returned by function FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix . If this is null, current function will have the same feature as function FoxitPDFSDKPython3.PDFPage.GetAnnotAtPoint . Default value: null.

Returns
  The array of annotation. If the return value of function FoxitPDFSDKPython3.AnnotArray.GetSize for the returned annotation array object is 0, that means no PDF annotation can be found.

## ◆ GetAnnotsAtPoint()

def FoxitPDFSDKPython3.PDFPage.GetAnnotsAtPoint | ( |  | position,
|  |  | tolerance
| ) |  |

Get all the annotations at a specified position, in [PDF coordinate system] ().

In one specified position, there may exist several annotations. This function can be used to retrieve all these annotations in the specified position. Annotations with flag FoxitPDFSDKPython3.Annot.e_FlagNoView or FoxitPDFSDKPython3.Annot.e_FlagHidden or FoxitPDFSDKPython3.Annot.e_FlagInvisible will not be retrieved by this function.
If the return annotation object of function FoxitPDFSDKPython3.AnnotArray.GetAt for the returned annotation array object has flag FoxitPDFSDKPython3.Annot.e_FlagReadOnly , that means the annotation cannot be modified.

Parameters

  [in] | position | The specified position, in [PDF coordinate system] ().
  [in] | tolerance | Tolerance value. Valid range: 0.0f to 30.0f.

Returns
  The array of annotation. If the return value of function FoxitPDFSDKPython3.AnnotArray.GetSize for the returned annotation array object is 0, that means no PDF annotation can be found.

## ◆ GetBox()

def FoxitPDFSDKPython3.PDFPage.GetBox | ( |  | box_type | ) |

Get page box.

Parameters

  [in] | box_type | Page box type. Please refer to values starting from FoxitPDFSDKPython3.PDFPage.e_MediaBox and this should be one of these values.

Returns
  A box rectangle, in [PDF coordinate system] ().

## ◆ GetContents()

def FoxitPDFSDKPython3.PDFPage.GetContents | ( |  | ) |

Get the PDF object of "Contents".

Note
  "Contents" can be either a PDF stream or a PDF array. Please refer to "TABLE 3.27 Entries in a page object" in <PDF Reference 1.7> P146 for more details.

Returns
  The PDF object of "Contents". If there is no "Contents" entry or any error occurs, this function will return null.

## ◆ GetDict()

def FoxitPDFSDKPython3.PDFPage.GetDict | ( |  | ) |

Get the page dictionary.

Returns
  The page dictionary object. If there is any error, this function will return null.

## ◆ GetDisplayMatrix()

def FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix | ( |  | left,
|  |  | top,
|  |  | width,
|  |  | height,
|  |  | rotate
| ) |  |

Get the display matrix of PDF page, from [PDF coordinate system] () to targeted device coordinate system.

Parameters

  [in] | left | Left position of the transformation area in device coordinate system, commonly in pixels.
  [in] | top | Top position of the transformation area in device coordinate system, commonly in pixels.
  [in] | width | Width of the transformation area in device coordinate system, commonly in pixels.
  [in] | height | Height of the transformation area in device coordinate system, commonly in pixels.
  [in] | rotate | Rotation value. Please refer to values starting from FoxitPDFSDKPython3.e_Rotation0 and this should be one of these values except FoxitPDFSDKPython3.e_RotationUnknown .

Returns
  The display matrix used for current PDF page.

## ◆ GetDocument()

def FoxitPDFSDKPython3.PDFPage.GetDocument | ( |  | ) |

Get the PDF document, to which current PDF page belongs.

Returns
  A PDF document object.

## ◆ GetGraphicsObjectAtDevicePoint()

def FoxitPDFSDKPython3.PDFPage.GetGraphicsObjectAtDevicePoint | ( |  | point,
|  |  | tolerance,
|  |  | matrix,
|  |  | filter
| ) |  |

Get the topmost graphics object in specified point in device coordinate system, with specified type filter.

Parameters

  [in] | point | A specified position, in device coordinate system.
  [in] | tolerance | Tolerance value for a graphics object hit detection, in point units. It should be positive.
  [in] | matrix | The transformation matrix. Usually this is returned by function FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix . Default value: null.
  [in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from FoxitPDFSDKPython3.GraphicsObject.e_TypeAll and this should be one of these values. FoxitPDFSDKPython3.GraphicsObject.e_TypeAll means for all kinds of graphics objects. Default value: FoxitPDFSDKPython3.GraphicsObject.e_TypeAll .

Returns
  A FoxitPDFSDKPython3.GraphicsObject object. If no graphics object can be found, this function will return null.

## ◆ GetGraphicsObjectAtPoint()

def FoxitPDFSDKPython3.PDFPage.GetGraphicsObjectAtPoint | ( |  | point,
|  |  | tolerance,
|  |  | filter
| ) |  |

Get the topmost graphics object in specified point, with specified type filter.

Parameters

  [in] | point | A specified position, in [PDF coordinate system] ().
  [in] | tolerance | Tolerance value for a graphics object hit detection, in point units. It should be positive.
  [in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from FoxitPDFSDKPython3.GraphicsObject.e_TypeAll and this should be one of these values. FoxitPDFSDKPython3.GraphicsObject.e_TypeAll means for all kinds of graphics objects. Default value: FoxitPDFSDKPython3.GraphicsObject.e_TypeAll .

Returns
  A FoxitPDFSDKPython3.GraphicsObject object. If no graphics object can be found, this function will return null.

## ◆ GetGraphicsObjectAtRectangle()

def FoxitPDFSDKPython3.PDFPage.GetGraphicsObjectAtRectangle | ( |  | rect,
|  |  | filter
| ) |  |

Get the topmost graphics object whose rectangle interasects with a specified rectangle, with specified type filter.

Parameters

  [in] | rect | A specified rectangle, in [PDF coordinate system] ().
  [in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from FoxitPDFSDKPython3.GraphicsObject.e_TypeAll and this should be one of these values. FoxitPDFSDKPython3.GraphicsObject.e_TypeAll means for all kinds of graphics objects. Default value: FoxitPDFSDKPython3.GraphicsObject.e_TypeAll .

Returns
  A graphics object whose rectangle intersects with the specified rectangle. If no suitable graphics object can be found, this function will return null.

## ◆ GetGraphicsObjectsAtDevicePoint()

def FoxitPDFSDKPython3.PDFPage.GetGraphicsObjectsAtDevicePoint | ( |  | point,
|  |  | tolerance,
|  |  | matrix,
|  |  | filter
| ) |  |

Get all the graphics objects in specified point in device coordinate system, with specified type filter.

Parameters

  [in] | point | A specified position, in device coordinate system.
  [in] | tolerance | Tolerance value for a graphics object hit detection, in point units. It should be positive.
  [in] | matrix | The transformation matrix. Usually this is returned by function FoxitPDFSDKPython3.PDFPage.GetDisplayMatrix . Default value: null.
  [in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from FoxitPDFSDKPython3.GraphicsObject.e_TypeAll and this should be one of these values. FoxitPDFSDKPython3.GraphicsObject.e_TypeAll means for all kinds of graphics objects. Default value: FoxitPDFSDKPython3.GraphicsObject.e_TypeAll .

Returns
  An array of FoxitPDFSDKPython3.GraphicsObject objects.

## ◆ GetGraphicsObjectsAtPoint()

def FoxitPDFSDKPython3.PDFPage.GetGraphicsObjectsAtPoint | ( |  | point,
|  |  | tolerance,
|  |  | filter
| ) |  |

Get all the graphics objects in specified point, with specified type filter.

Parameters

  [in] | point | A specified position, in [PDF coordinate system] ().
  [in] | tolerance | Tolerance value for a graphics object hit detection, in point units. It should be positive.
  [in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from FoxitPDFSDKPython3.GraphicsObject.e_TypeAll and this should be one of these values. FoxitPDFSDKPython3.GraphicsObject.e_TypeAll means for all kinds of graphics objects. Default value: FoxitPDFSDKPython3.GraphicsObject.e_TypeAll .

Returns
  An array of FoxitPDFSDKPython3.GraphicsObject objects.

## ◆ GetGraphicsObjectsAtRectangle()

def FoxitPDFSDKPython3.PDFPage.GetGraphicsObjectsAtRectangle | ( |  | rect,
|  |  | filter
| ) |  |

Get all the graphics objects whose rectangles intersect with a specified rectangle, with specified type filter.

Parameters

  [in] | rect | A specified rectangle, in [PDF coordinate system] ().
  [in] | filter | Type filter that specifies which kind of graphics object is to be gotten. Please refer to values starting from FoxitPDFSDKPython3.GraphicsObject.e_TypeAll and this should be one of these values. FoxitPDFSDKPython3.GraphicsObject.e_TypeAll means for all kinds of graphics objects. Default value: FoxitPDFSDKPython3.GraphicsObject.e_TypeAll .

Returns
  An array of graphics objects whose rectangle intersect with the specified rectangle.

## ◆ GetHeight()

def FoxitPDFSDKPython3.PDFPage.GetHeight | ( |  | ) |

Get the page height (unit is 1/72 inch).

Returns
  Page height.

## ◆ GetIndex()

def FoxitPDFSDKPython3.PDFPage.GetIndex | ( |  | ) |

Get page index.

Returns
  Page index, starting from 0 and within the count of pages in related PDF document.

## ◆ GetInheritedAttribute()

def FoxitPDFSDKPython3.PDFPage.GetInheritedAttribute | ( |  | attruibute_name | ) |

Get the PDF object for specified attribute which may be inherited from the ancestor node in the page tree.

Some of the page attributes are designated as inheritable, such as "Resources", "MediaBox", "CropBox", and "Rotate". Please refer to "TABLE 3.27 Entries in a page object" in <PDF Reference 1.7> P145 and "Inheritance of Page Attributes" in <PDF Reference 1.7> P149 for more details.

Parameters

  [in] | attruibute_name | The name of attribute to be found.

Returns
  A PDF object. If not found, this function will return null.

## ◆ GetResources()

def FoxitPDFSDKPython3.PDFPage.GetResources | ( |  | ) |

Get the PDF dictionary of "Resources".

Note
  Please refer to "TABLE 3.27 Entries in a page object" in <PDF Reference 1.7> P145 for more details.

Returns
  The PDF dictionary of "Resources". If there is no "Resources" entry or any error occurs, this function will return null.

## ◆ GetRotation()

def FoxitPDFSDKPython3.PDFPage.GetRotation | ( |  | ) |

Get the page rotation.

Returns
  Page rotation value. Please refer to values starting from FoxitPDFSDKPython3.e_Rotation0 and this would be one of these values.

## ◆ GetSuggestedRect()

def FoxitPDFSDKPython3.PDFPage.GetSuggestedRect | ( |  | render_result,
|  |  | render_matrix,
|  |  | point
| ) |  |

Get the suggested rectangle (in [PDF coordinate system] ()) for a point (in [PDF coordinate system] ()) based on the rendering result bitmap.

This function can help user to locate a rectangle area (as a suggested rectangle) around a specified point. When a valid suggested rectangle is retrieved, user can use the rectangle to add something to PDF page, such as a new annotation, a new form field, a new signature and etc.
The suggested rectangle for a point means a rectangle which contains specified point and can be drawn in the spare place around the specified point as large as possible. BUT, if any of left/right/top/bottom directions from the point reaches the input bitmap edges directly, no suggested rectangle can be retrieved.
This function does not support a Rbg565 bitmap. If input bitmap is a Rbg565 bitmap, this function will return an empty rectangle directly.

Parameters

  [in] | render_result | Bitmap as the result of rendering current PDF page. This should be a valid bitmap object.
  [in] | render_matrix | The transformation matrix used for rendering current PDF page and generating parameter render_result as rendering result.
  [in] | point | A point (in [PDF coordinate system] ()) for which a suggested rectangle is to be found.

Returns
  The suggested rectangle in [PDF coordinate system] (). If the return value of function RectF::IsEmpty for the returned rectangle object is true, that means no suitable suggested rectangle can be found.

## ◆ GetThumb()

def FoxitPDFSDKPython3.PDFPage.GetThumb | ( |  | ) |

Get the PDF stream of "Thumb".

Note
  Please refer to "TABLE 3.27 Entries in a page object" in <PDF Reference 1.7> P146 for more details.

Returns
  The PDF stream of "Thumb". If there is no "Thumb" entry or any error occurs, this function will return null.

## ◆ GetUserUnitSize()

def FoxitPDFSDKPython3.PDFPage.GetUserUnitSize | ( |  | ) |

Get the user unit.

A positive number giving the size of default user space units, in multiples of 1/72 inch. The range of supported values is implementation-dependent.

Returns
  User unit.

## ◆ GetWidth()

def FoxitPDFSDKPython3.PDFPage.GetWidth | ( |  | ) |

Get the page width (unit is 1/72 inch).

Returns
  Page width.

## ◆ HasTransparency()

def FoxitPDFSDKPython3.PDFPage.HasTransparency | ( |  | ) |

Check whether current PDF page has transparency or not.

Before using this function, please ensure current page has been parsed.

Returns
  true means current page has transparency, while false means current page does not have transparency.

## ◆ HasWatermark()

def FoxitPDFSDKPython3.PDFPage.HasWatermark | ( |  | ) |

Check whether the current page has any watermark (not including Foxit PDF SDK trial watermark).

Before using this function, please ensure current page has been parsed.

Returns
  true means the current page has watermark, and false means the current page has no watermark.

## ◆ IsParsed()

def FoxitPDFSDKPython3.PDFPage.IsParsed | ( |  | ) |

Check if current page has been parsed or not.

Returns
  true means current page has been parsed, while false means current page has not been parsed yet.

## ◆ IsScanned()

def FoxitPDFSDKPython3.PDFPage.IsScanned | ( |  | ) |

Check whether current PDF page is scanned page or not.

Before using this function, please ensure current page has been parsed.

Returns
  true means current page is scanned, while false means current page is not scanned.

## ◆ LoadThumbnail()

def FoxitPDFSDKPython3.PDFPage.LoadThumbnail | ( |  | ) |

Load the thumbnail bitmap.

Returns
  The thumbnail bitmap of current page. If the return value of function FoxitPDFSDKPython3.Bitmap.IsEmpty for the returned bitmap object is true, that means no thumbnail can be found.

## ◆ MoveAnnotToFirst()

def FoxitPDFSDKPython3.PDFPage.MoveAnnotToFirst | ( |  | annot | ) |

Change specified annotation to be the first one of all annotations.

In PDF page, all the annotations are managed in an annotation list. In the annotation list, annotations with small indexes (as in the font part of the list) will be drawn to the page first, and annotations with large indexes (as in the last part of the list) will be drawn to the page later. So, in a page, if an annotation is shown on the top of other annotations in z-order, that means its index is larger than other annotations in the annotation list.
This function is used to move an annotation from current index position to the first position in the annotation list, in order to move the annotation to the bottom in z-order when displayed.

Parameters

  [in] | annot | An annotation object to be moved to first. It should be in current PDF page.

Returns
  None.

## ◆ MoveAnnotToLast()

def FoxitPDFSDKPython3.PDFPage.MoveAnnotToLast | ( |  | annot | ) |

Change specified annotation to be the last one of all annotations.

In PDF page, all the annotations are managed in an annotation list. In the annotation list, annotations with small indexes (as in the font part of the list) will be drawn to the page first, and annotations with large indexes (as in the last part of the list) will be drawn to the page later. So, in a page, if an annotation is shown on the top of other annotations in z-order, that means its index is larger than other annotations in the annotation list.
This function is used to move an annotation from current index position to the last position in the annotation list, in order to move the annotation to the top in z-order when displayed.

Parameters

  [in] | annot | An annotation object to be moved to last. It should be in current PDF page.

Returns
  None.

## ◆ MoveAnnotToNext()

def FoxitPDFSDKPython3.PDFPage.MoveAnnotToNext | ( |  | annot | ) |

Exchange the indexes of current annotation and its next annotation.

In PDF page, all the annotations are managed in an annotation list. In the annotation list, annotations with small indexes (as in the font part of the list) will be drawn to the page first, and annotations with large indexes (as in the last part of the list) will be drawn to the page later. So, in a page, if an annotation is shown on the top of other annotations in z-order, that means its index is larger than other annotations in the annotation list.
This function is used to exchange the indexes position of current annotation and its next annotation in the annotation list, in order to move the annotation to an upper level in z-order when displayed.

Parameters

  [in] | annot | An annotation object to be moved. It should be in current PDF page.

Returns
  None.

## ◆ MoveAnnotToPrev()

def FoxitPDFSDKPython3.PDFPage.MoveAnnotToPrev | ( |  | annot | ) |

Exchange the indexes of current annotation and its previous annotation.

In PDF page, all the annotations are managed in an annotation list. In the annotation list, annotations with small indexes (as in the font part of the list) will be drawn to the page first, and annotations with large indexes (as in the last part of the list) will be drawn to the page later. So, in a page, if an annotation is shown on the top of other annotations in z-order, that means its index is larger than other annotations in the annotation list.
This function is used to exchange the indexes position of current annotation and its previous annotation in the annotation list, in order to move the annotation to a lower level in z-order when displayed.

Parameters

  [in] | annot | An annotation object to be moved. It should be in current PDF page.

Returns
  None.

## ◆ Normalize()

def FoxitPDFSDKPython3.PDFPage.Normalize | ( |  | ) |

Transform current PDF page by undoing any rotation and removing the offset to the page's "CropBox".

Returns
  true means success, while false means failure.

Note
  Annotations and form fields will also be adjusted to remain in the same relative position on the PDF page. This makes it easier to add new items to the PDF page as the coordinate system will be relative to the bottom left corner of the visible page.

## ◆ RemoveAllWatermarks()

def FoxitPDFSDKPython3.PDFPage.RemoveAllWatermarks | ( |  | ) |

Remove all watermarks.

Before using this function, please ensure current page has been parsed.

Returns
  true means success, while false means failure.

## ◆ RemoveAnnot()

def FoxitPDFSDKPython3.PDFPage.RemoveAnnot | ( |  | annot | ) |

Remove an annotation.

This function can remove any annotation returned by getting function or adding function.
But for widget annotation, this function can only remove an independent widget annotation. If the widget annotation is associated with a form field, this function cannot remove it and will throw exception FoxitPDFSDKPython3.e_ErrUnsupported .
For a widget annotation associated with a form field, please call function FoxitPDFSDKPython3.Form.RemoveControl to remove it along with associated form control.

Parameters

  [in] | annot | An annotation object to be removed. It should be in current PDF page.

Returns
  true means success, while false means failure.

## ◆ SetAnnotGroup()

def FoxitPDFSDKPython3.PDFPage.SetAnnotGroup | ( |  | annot_array,
|  |  | header_index
| ) |  |

Group all the input markup annotations together.

Markup annotations can be grouped. The group consists of a primary annotation and one or more subordinate annotations. Some entries in the primary annotation are treated as group attributes that should apply to the group as a whole; the corresponding entries in the subordinate annotations should be ignored. These entries are contents, last modification time, fill color/border color, title, pop-up annotation, creation time, subject, and open status. So user should respect the group property: when a property of an annotation in the group is changed, the other annotations in the same group should be changed too.
Operations that manipulate any annotation in a group, such as movement, cut, and copy, should be treated by viewer applications as acting on the entire group.

Parameters

  [in] | annot_array | An array of Markup objects that specifies markup annotations which are to be grouped together. This array should contains at least 2 markup annotations, and all the markup annotations in this array should be different from others. All the markup annotations in this array should be in current page. Specially, if a markup annotation in this array is already in another group, that group will be set to the new group with the new header as well.
  [in] | header_index | The index that specifies a markup annotation in parameter annot_array to be the header of the group. Valid range: from 0 to (annot_count -1).

Returns
  true means group input markup annotations together successfully, while false means failure.

## ◆ SetBox()

def FoxitPDFSDKPython3.PDFPage.SetBox | ( |  | box_type,
|  |  | box
| ) |  |

Set page box.

Parameters

  [in] | box_type | Page box type. Please refer to values starting from FoxitPDFSDKPython3.PDFPage.e_MediaBox and this should be one of these values.
  [in] | box | New box rectangle, in [PDF coordinate system] ().

Returns
  None.

## ◆ SetClipRect()

def FoxitPDFSDKPython3.PDFPage.SetClipRect | ( |  | clip_rect | ) |

Set clip rectangle for all graphics objects on current PDF page.

After this function finishes successfully, please re-parse current page by function FoxitPDFSDKPython3.PDFPage.StartParse with parameter is_reparse true.

Parameters

  [in] | clip_rect | New clip rectangle, in [PDF coordinate system] ().

Returns
  None.

## ◆ SetRotation()

def FoxitPDFSDKPython3.PDFPage.SetRotation | ( |  | rotate | ) |

Set page rotation.

Parameters

  [in] | rotate | New page rotation value. Please refer to values starting from FoxitPDFSDKPython3.e_Rotation0 and this should be one of these values except FoxitPDFSDKPython3.e_RotationUnknown .

Returns
  None.

## ◆ SetSize() [1/2]

def FoxitPDFSDKPython3.PDFPage.SetSize | ( |  | size | ) |

Set page size type.

When changing page size, Foxit PDF SDK will always do as following:
First, choose "page rotation is 0" as the basis page status and choose the left-bottom corner of the page (with page rotation is 0) as the basis point. And then, always change the position of top page boundary and right page boundary (with page rotation is 0) to change page size.

Parameters

  [in] | size | Size type to specify the new size of current page. Please refer to values starting from FoxitPDFSDKPython3.PDFPage.e_SizeLetter and this should be one of these values.

Returns
  None.

## ◆ SetSize() [2/2]

def FoxitPDFSDKPython3.PDFPage.SetSize | ( |  | width,
|  |  | height
| ) |  |

Set page width and height.

When changing page width/height, Foxit PDF SDK will always do as following:
First, choose "page rotation is 0" as the basis page status and choose the left-bottom corner of the page (with page rotation is 0) as the basis point. And then, always change the position of top page boundary and right page boundary (with page rotation is 0) to change page size.

Parameters

  [in] | width | New page width. It should be a positive value and the unit is 1/72 inch.
  [in] | height | New page height. It should be a positive value and the unit is 1/72 inch.

Returns
  None.

## ◆ SetThumbnail()

def FoxitPDFSDKPython3.PDFPage.SetThumbnail | ( |  | thumbnail | ) |

Set page thumbnail.

Thumbnail bitmap does not use alpha channel. So user is recommended to set a bitmap without alpha channel to be the new thumbnail. If a bitmap with alpha channel is set, the new thumbnail will use white background by default. Currently, this function does not support the bitmap with format FoxitPDFSDKPython3.Bitmap.e_DIBRgb565 .

Parameters

  [in] | thumbnail | New page thumbnail. It should be a valid bitmap.

Returns
  None.

## ◆ SetUserUnitSize()

def FoxitPDFSDKPython3.PDFPage.SetUserUnitSize | ( |  | user_unit | ) |

Set the user unit.

A positive number giving the size of default user space units, in multiples of 1/72 inch. The range of supported values is implementation-dependent. If not set, Foxit PDF SDK will use default value 1.0 (user unit is 1/72 inch).

Parameters

  [in] | user_unit | A positive number giving the size of default user space units, in multiples of 1/72 inch.

Returns
  None.

## ◆ SplitTextsInRectangle()

def FoxitPDFSDKPython3.PDFPage.SplitTextsInRectangle | ( |  | rect,
|  |  | split_step
| ) |  |

Split text objects whose rectangles (in [PDF coordinate system] ()) intersect with a specified rectangle (in [PDF coordinate system] ()), and further split the intersecting portion based on split_step.

This function splits text objects that intersect with the specified rectangle based on split_step. When a text object intersects with the specified rectangle, the intersecting portion will be divided into one or more text objects based on split_step. Similarly, for text objects that only partially intersect with the specified rectangle, their non-intersecting portions will be split off and treated as separate text objects. If split_step is greater than 0, the part of the text object that intersects with the specified rectangle will be split into several text objects. Specifically, each new text object will correspond to a segment in the specified rectangle, with the number of words in each segment defined by split_step. If the remaining number of words in the intersecting portion is less than split_step, those remaining words will be grouped into a single text object. If split_step is 0, the intersecting portion of the text object that intersects with the specified rectangle will not be split further and will be grouped into a single text object.

Parameters

  [in] | rect | A specified rectangle, in [PDF coordinate system] ().
  [in] | split_step | The number of words used to split the text objects that intersects the specified rectangle. This value must not be negative. a value of 0 means the text objects that intersects with the specified rectangle will not be further split and will be grouped into a single text object.

Returns
  An array of text graphics objects that intersect with the specified rectangle after being split.

Note
  Text objects whose rectangles (in [PDF coordinate system] ()) intersect the specified rectangle (in [PDF coordinate system] ()) will be split separately and not merged together. If text objects whose rectangles (in [PDF coordinate system] ()) intersects the specified rectangle (in PDF coordinate system), but all of its characters lie outside the specified rectangle (in [PDF coordinate system] ()), the text objects would not be treated as split text objects within specified rectangle (in [PDF coordinate system] ()).

## ◆ StartParse()

def FoxitPDFSDKPython3.PDFPage.StartParse | ( |  | flags,
|  |  | pause,
|  |  | is_reparse
| ) |  |

Start to parse current page.

It may take a long time to parsing a PDF page, so Foxit PDF SDK uses a progressive process to do this. All the resources of page content will be loaded after the PDF page is parsed.
User can get the dictionary of page or annotations without parsing the page, but to perform operations related to the page content, please parse the page first.

Parameters

  [in] | flags | Parsing flags. Please refer to values starting from FoxitPDFSDKPython3.PDFPage.e_ParsePageNormal and this should be one or a combination of these values. Default value: FoxitPDFSDKPython3.PDFPage.e_ParsePageNormal .
  [in] | pause | Pause callback object which decides if the parsing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. Default value: null.
  [in] | is_reparse | true means to re-parse current page, while false means not to re-parse current page. Default value: false.

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.

Note
  When parameter is_reparse is set to true, that means to re-parse current PDF page, and all the retrieved graphics object's position (as POSITION object) and graphics object (as FoxitPDFSDKPython3.GraphicsObject object) will be invalid.
  Application needs to get graphics objects again after re-parsing a PDF page.

## ◆ Transform()

def FoxitPDFSDKPython3.PDFPage.Transform | ( |  | matrix,
|  |  | need_transform_clip_path,
|  |  | need_transform_annotations
| ) |  |

Transform a PDF page, including annotations and form fields on the page.

Note
  This function only supports scaling and translating. After this operation, please re-parse current page by function FoxitPDFSDKPython3.PDFPage.StartParse with parameter is_reparse true, in order that expected content will be displayed.

Parameters

  [in] | matrix | Transform matrix.
  [in] | need_transform_clip_path | true means to transform the page with clip rectangle, while false means not.
  [in] | need_transform_annotations | true means to transform the page with annotations. while false means not.

Returns
  true means success, while false means failure.

## ◆ UpdateAnnotList()

def FoxitPDFSDKPython3.PDFPage.UpdateAnnotList | ( |  | ) |

Update the annotation list.

If any annotation is modified(added/removed...) by changing "Annots" dictionary item directly, please call this function to update the annotation list after the changing.

Returns
  None.

## Member Data Documentation

## ◆ e_ArtBox

FoxitPDFSDKPython3.PDFPage.e_ArtBox = _fsdk.PDFPage_e_ArtBox
| static

Art Box for page boundary.

The intended dimensions of a finished page after trimming.

## ◆ e_BleedBox

FoxitPDFSDKPython3.PDFPage.e_BleedBox = _fsdk.PDFPage_e_BleedBox
| static

Bleed Box for page boundary.

The extent of page's meaningful content (including potential white space) as intended by page's creator.

## ◆ e_CropBox

FoxitPDFSDKPython3.PDFPage.e_CropBox = _fsdk.PDFPage_e_CropBox
| static

Crop Box for page boundary.

The region to which the contents of page are to be clipped (cropped) while displaying or printing.

## ◆ e_MediaBox

FoxitPDFSDKPython3.PDFPage.e_MediaBox = _fsdk.PDFPage_e_MediaBox
| static

Media Box for page boundary.

The boundary of the physical medium on which page is to be displayed or printed.

## ◆ e_TrimBox

FoxitPDFSDKPython3.PDFPage.e_TrimBox = _fsdk.PDFPage_e_TrimBox
| static

Trim Box for page boundary.

The region to which the contents of page should be clipped while outputting in a production environment.