Foxit PDF SDK
fsdk.FreeText Class Reference

Public Member Functions

def AllowTextOverflow (is_text_overflow)
 Decide whether to allow the text of freetext to overflow or not. More...
 
def GetAlignment ()
 
def GetCalloutLineEndingStyle ()
 Get line ending style of the start point in a callout line. More...
 
def GetCalloutLinePoints ()
 Get a point of callout line points. More...
 
def GetDefaultAppearance ()
 Get default appearance data. More...
 
def GetFillColor ()
 Get fill color. More...
 
def GetInnerRect ()
 Get the inner rectangle. More...
 
def GetRotation ()
 Get current rotation value (in clockwise). More...
 
def GetTextMatrix ()
 
def Rotate (rotation)
 Rotate current annotation from current state with specified rotation value (in clockwise). More...
 
def SetAlignment (alignment)
 
def SetCalloutLineEndingStyle (ending_style)
 Set line ending style of the start point in a callout line. More...
 
def SetCalloutLinePoints (point_array)
 Set points for callout line. More...
 
def SetDefaultAppearance (default_ap)
 Set default appearance data. More...
 
def SetFillColor (fill_color)
 Set fill color. More...
 
def SetInnerRect (inner_rect)
 Set the inner rectangle. More...
 
def SetRotation (rotation)
 Set rotation value (in clockwise). More...
 
def SetTextMatrix (text_matrix)
 

Detailed Description

A free text annotation displays text directly on the page. So free text annotation does not need a related pop-up annotation to show the text.
Free text annotation is a kind of markup annotation, so class FreeText is derived from class Markup , and also offers functions to get/set free text annotation's properties and reset appearance stream of a free text annotation.

Note
For a newly created free text annotation, if user calls function fsdk.Annot.ResetAppearanceStream directly without setting any properties, the default appearance will be used:
border width = 1.0, border style = fsdk.BorderInfoE_Solid , border color = 0xFFFF0000 (red), opacity = 1.0, alignment = 0 (as left-justified), default appearance flags = fsdk.DefaultAppearanceE_FlagFont | fsdk.DefaultAppearanceE_FlagTextColor | fsdk.DefaultAppearanceE_FlagFontSize , default appearance font is created based on fsdk.FontE_StdIDHelvetica , default appearance text size = 12, default appearance text color = 0xFF0000FF (blue).
See also
Markup

Member Function Documentation

◆ AllowTextOverflow()

def fsdk.FreeText.AllowTextOverflow (   is_text_overflow)

Decide whether to allow the text of freetext to overflow or not.

For callout object and textbox object, if this function is not called,text of callout or textbox is allowed to overflow by default. For typewriter object, if this function is not called, text of typerwriter is not allowed to overflow by default.

Parameters
[in]is_text_overflowA boolean value to decide whether text content is allowed to overflow or not when the size of the freetext rectangle is smaller than the size of the text content:
  • true means text content is allowed to overflow. So in this case, overflowed text content will be truncated.

  • false means text content is not allowed to overflow. So in this case, the callout rectangle will be adapted to contain the whole text content automatically.

Returns
None.

◆ GetAlignment()

def fsdk.FreeText.GetAlignment ( )
Deprecated:
Current function has been deprecated since Foxit PDF SDK 8.2. This property will not have any effect on free text annotation's appearance any more.For getting the alignment property, please call function fsdk.Markup.GetRichTextStyle . Please refer to RichText related function in Markup for more details.

This property has effect on free text annotation's appearance.

Returns
The alignment value. Please refer to values starting from fsdk.E_AlignmentLeft and this would be one of these values.

◆ GetCalloutLineEndingStyle()

def fsdk.FreeText.GetCalloutLineEndingStyle ( )

Get line ending style of the start point in a callout line.

Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have line ending style property, and this property has effect on this kind of free text annotation's appearance.

Returns
The line ending style of the start point. Please refer to values starting from fsdk.MarkupE_EndingStyleNone and this would be one of these values.

◆ GetCalloutLinePoints()

def fsdk.FreeText.GetCalloutLinePoints ( )

Get a point of callout line points.

Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have callout line points property, and this property has effect on this kind of free text annotation's appearance. For a callout line, it can contain 2 or 3 points:

  • 2 points represent the starting point and ending point of the callout line.

  • 3 points represent the starting point, knee point, and ending point of the callout line.

Returns
A point array that represents the points used for callout line of a callout free text annotation.

◆ GetDefaultAppearance()

def fsdk.FreeText.GetDefaultAppearance ( )

Get default appearance data.

This property has effect on free text annotation's appearance. Default appearance data can be used in formatting text.

Returns
The default appearance data.

◆ GetFillColor()

def fsdk.FreeText.GetFillColor ( )

Get fill color.

This property has effect on free text annotation's appearance. Fill color is used to fill the background of text box, and also for some callout line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".

Returns
The fill color. Format: 0xRRGGBB. If no fill color can be found, 0x000000 will be returned.

◆ GetInnerRect()

def fsdk.FreeText.GetInnerRect ( )

Get the inner rectangle.

This property has effect on free text annotation's appearance. For a free text annotation, inner rectangle is where the annotation's text should be displayed. The inner rectangle could be just the same as or less than the annotation's rectangle, and should never be larger than annotation's rectangle.

Returns
The inner rectangle.

◆ GetRotation()

def fsdk.FreeText.GetRotation ( )

Get current rotation value (in clockwise).

Returns
Current rotation value (in clockwise). Please refer to values starting from fsdk.E_Rotation0 and this would be one of these values.

◆ GetTextMatrix()

def fsdk.FreeText.GetTextMatrix ( )
Deprecated:
Current function has been deprecated since Foxit PDF SDK 7.4. This property will not have any effect on annotation's appearance any more.

This property has effect on free text annotation's appearance. This property can be used to change the skew of text's display.

Returns
Matrix used for text in default appearance.

◆ Rotate()

def fsdk.FreeText.Rotate (   rotation)

Rotate current annotation from current state with specified rotation value (in clockwise).

Parameters
[in]rotationRotation value which represents the degree used to rotate current annotation from current state in clockwise. Please refer to values starting from fsdk.E_Rotation0 and this should be one of these values except fsdk.E_RotationUnknown . Specially, if the input value is fsdk.E_Rotation0 (which means not to rotate current annotation), current function will do nothing.
Returns
true means success, while false means failure.

◆ SetAlignment()

def fsdk.FreeText.SetAlignment (   alignment)
Deprecated:
Current function has been deprecated since Foxit PDF SDK 8.2. This property will not have any effect on free text annotation's appearance any more.For setting the alignment property, please call function fsdk.Markup.SetRichTextStyle . Please refer to RichText related function in Markup for more details.

This property has effect on free text annotation's appearance. If user wants the new alignment has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new alignment.

Parameters
[in]alignmentThe new alignment value. Please refer to values starting from fsdk.E_AlignmentLeft and this should be one of these values.
If other values is used to set, fsdk.E_AlignmentLeft will be used by default.
Returns
None.

◆ SetCalloutLineEndingStyle()

def fsdk.FreeText.SetCalloutLineEndingStyle (   ending_style)

Set line ending style of the start point in a callout line.

Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have line ending style property, and this property has effect on this kind of free text annotation's appearance.
If user wants the new line ending style has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new line ending style.

Parameters
[in]ending_styleThe line ending style for the start point to be set. Please refer to values starting from fsdk.MarkupE_EndingStyleNone and this should be one of these values.
Returns
None.

◆ SetCalloutLinePoints()

def fsdk.FreeText.SetCalloutLinePoints (   point_array)

Set points for callout line.

Only when the intent name of a free text annotation is "FreeTextCallout", this free text annotation can have callout line points property, and this property has effect on this kind of free text annotation's appearance. For a callout line, it can contain 2 or 3 points:

  • 2 points represent the starting point and ending point of the callout line.

  • 3 points represent the starting point, knee point, and ending point of the callout line.

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

Parameters
[in]point_arrayNew point array that specifies the starting point, knee point(if any) and ending point of the callout line. The count of elements should be 2 or 3: 2 points meand starting point and ending point; 3 points means the startign point, knee point and ending point.
If the count of elements is above 3, only the first 3 points will be used to set callout line.
Returns
None.

◆ SetDefaultAppearance()

def fsdk.FreeText.SetDefaultAppearance (   default_ap)

Set default appearance data.

This property has effect on free text annotation's appearance. Default appearance data can be used in formatting text.
If user wants the new default appearance data has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new default appearance data.

Parameters
[in]default_apThe new default appearance data to be set. flags of input data can be used to decide which information is/are to be updated with the new data; for those no updated data, they will keep to use old data.
Returns
true means success, while false means failure. Specially, this function will return false if the parameter default_ap contains any incorrect value, for example:

◆ SetFillColor()

def fsdk.FreeText.SetFillColor (   fill_color)

Set fill color.

This property has effect on free text annotation's appearance. Fill color is used to fill the background of text box, and also for some callout line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".
If user wants the new fill color has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new fill color.

Parameters
[in]fill_colorNew fill color to be set. Format: 0xRRGGBB.
Returns
None.

◆ SetInnerRect()

def fsdk.FreeText.SetInnerRect (   inner_rect)

Set the inner rectangle.

This property has effect on free text annotation's appearance. For a free text annotation, inner rectangle is where the annotation's text should be displayed. The inner rectangle could be just the same as or less than the annotation's rectangle, and should never be larger than annotation's rectangle.
If user wants the new inner rectangle has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new inner rectangle.

Parameters
[in]inner_rectNew inner rectangle to be set. It should be same as or less than annotation's rectangle.
Returns
None.

◆ SetRotation()

def fsdk.FreeText.SetRotation (   rotation)

Set rotation value (in clockwise).

This property has effect on free text annotation's appearance. If user wants the new rotation has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new rotation.

Parameters
[in]rotationNew rotation value (in clockwise) to be set to current free text annotation. Please refer to values starting from fsdk.E_Rotation0 and this should be one of these values except fsdk.E_RotationUnknown .
Returns
None.

◆ SetTextMatrix()

def fsdk.FreeText.SetTextMatrix (   text_matrix)
Deprecated:
Current function has been deprecated since Foxit PDF SDK 7.4. This property will not have any effect on annotation's appearance any more.

This property has effect on free text annotation's appearance. This property can be used to change the skew of text's display.
If user wants the new text matrix has effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting new text matrix.

Parameters
[in]text_matrixThe new text matrix.
Returns
None.