Foxit PDF SDK
fsdk.Caret Class Reference

Public Member Functions

def GetInnerRect ()
 Get the inner rectangle. More...
 
def SetInnerRect (inner_rect)
 Set the inner rectangle. More...
 

Detailed Description

A caret annotation (PDF 1.5) is a visual symbol that indicates the presence of text edits.
Caret annotation is a kind of markup annotation, so class Caret is derived from class Markup , and also offers functions to get/set caret annotation's properties and reset appearance stream of a caret annotation.

Note
For a newly created caret annotation, if user calls function fsdk.Annot.ResetAppearanceStream directly without setting any other properties, the default appearance will be used:
border color = 0xFFA7ABE8 (a kind of purple), opacity = 1.0.
See also
Markup

Member Function Documentation

◆ GetInnerRect()

def fsdk.Caret.GetInnerRect ( )

Get the inner rectangle.

This property has effect on caret annotation's appearance. For a caret annotation, inner rectangle means the actual boundaries of underlying caret. 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.

◆ SetInnerRect()

def fsdk.Caret.SetInnerRect (   inner_rect)

Set the inner rectangle.

This property has effect on caret annotation's appearance. For a caret annotation, inner rectangle means the actual boundaries of underlying caret. 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 have effect on annotation's appearance, please call function fsdk.Annot.ResetAppearanceStream after setting the 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.