Foxit PDF SDK
fsdk.TextMarkup Class Reference

Public Member Functions

def GetQuadPoints ()
 Get quadrilaterals. More...
 
def SetQuadPoints (quad_points_array)
 Set quadrilaterals. More...
 

Detailed Description

Text markup annotations appear as highlights, underlines, strikeouts, or squiggly lines in the text of a document. Text markup annotations are all markup annotations, so class TextMarkup is derived from class Markup . It is the base class for all PDF text markup annotations. It offers the base functions to get/set text markup annotation's common properties.
Especially, for a text markup annotation, quadrilaterals are required. So please ensure that a text markup annotation has valid quadrilaterals before resetting its appearance stream.
For concrete text markup annotation types, please refer to derived classes.

See also
Markup

Member Function Documentation

◆ GetQuadPoints()

def fsdk.TextMarkup.GetQuadPoints ( )

Get quadrilaterals.

This property has effect on text markup annotation's appearance. The order of points in a quadrilateral should be:

  • The first point is the point in left-top corner of the quadrilateral.

  • The second point is the point in right-top corner of the quadrilateral.

  • The third point is the point in left-bottom corner of the quadrilateral.

  • The fourth point is the point in right-bottom corner of the quadrilateral.

Returns
A quadrilateral points array that receives the quadrilaterals value.

◆ SetQuadPoints()

def fsdk.TextMarkup.SetQuadPoints (   quad_points_array)

Set quadrilaterals.

For a text markup annotation, quadrilaterals are required. This property has effect on text markup annotation's appearance. After setting new quadrilaterals, rectangle of current text markup annotation will be updated as well. The order of points in a quadrilateral should be:

  • The first point is the point in left-top corner of the quadrilateral.

  • The second point is the point in right-top corner of the quadrilateral.

  • The third point is the point in left-bottom corner of the quadrilateral.

  • The fourth point is the point in right-bottom corner of the quadrilateral.

If user wants the new quadrilaterals has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting quadrilaterals.

Parameters
[in]quad_points_arrayA valid array of quadrilaterals. It should not be an empty array.
Returns
None.