Foxit PDF SDK
fsdk.TextPageCharInfo Class Reference

Public Member Functions

def GetChar_box ()
 Get the glyph bounding box in page space. More...
 
def GetChar_outbox ()
 Get the typographic(display and printing) bounding box in page space. More...
 
def GetFlag ()
 Get flags to indicate which properties of textpage character flag are meaningful. More...
 
def GetFont ()
 Get a font for character. More...
 
def GetFont_size ()
 Get font size for character. More...
 
def GetMatrix ()
 Get the matrix of the character. More...
 
def GetOrigin_x ()
 Get the x-coordinate of the origin position. More...
 
def GetOrigin_y ()
 Get the y-coordinate of the origin position. More...
 
def Set (font, flag, font_size, origin_x, origin_y, char_box, char_outbox, matrix)
 Set value.
More...
 
def SetChar_box (value)
 Set the glyph bounding box in page space. More...
 
def SetChar_outbox (value)
 Set the typographic(display and printing) bounding box in page space. More...
 
def SetFlag (value)
 Set flags to indicate which properties of textpage character flag are meaningful. More...
 
def SetFont (value)
 Set a font for character. More...
 
def SetFont_size (value)
 Set font size for character. More...
 
def SetMatrix (value)
 Set the matrix of the character. More...
 
def SetOrigin_x (value)
 Set the x-coordinate of the origin position. More...
 
def SetOrigin_y (value)
 Set the y-coordinate of the origin position. More...
 

Detailed Description

This class represents textpage character information.

Member Function Documentation

◆ GetChar_box()

fsdk.TextPageCharInfo.GetChar_box ( )

Get the glyph bounding box in page space.

Returns
The glyph bounding box in page space.

◆ GetChar_outbox()

fsdk.TextPageCharInfo.GetChar_outbox ( )

Get the typographic(display and printing) bounding box in page space.

Returns
The typographic(display and printing) bounding box in page space.

◆ GetFlag()

fsdk.TextPageCharInfo.GetFlag ( )

Get flags to indicate which properties of textpage character flag are meaningful.

Please refer to values starting from fsdk.TextPageCharInfoE_Normal and this should be one of these values.

Returns
Flags to indicate which properties of textpage character flag are meaningful.

◆ GetFont()

fsdk.TextPageCharInfo.GetFont ( )

Get a font for character.

Returns
A font for character.

◆ GetFont_size()

fsdk.TextPageCharInfo.GetFont_size ( )

Get font size for character.

This value would a positive value.

Returns
Font size for character.

◆ GetMatrix()

fsdk.TextPageCharInfo.GetMatrix ( )

Get the matrix of the character.

Returns
The matrix of the character.

◆ GetOrigin_x()

fsdk.TextPageCharInfo.GetOrigin_x ( )

Get the x-coordinate of the origin position.

Returns
The x-coordinate of the origin position.

◆ GetOrigin_y()

fsdk.TextPageCharInfo.GetOrigin_y ( )

Get the y-coordinate of the origin position.

Returns
The y-coordinate of the origin position.

◆ Set()

def fsdk.TextPageCharInfo.Set (   font,
  flag,
  font_size,
  origin_x,
  origin_y,
  char_box,
  char_outbox,
  matrix 
)

Set value.

Parameters
[in]fontA valid font object.
[in]flagFlags to indicate which properties of textpage character flag are meaningful. Please refer to values starting from fsdk.TextPageCharInfoE_Normal and this should be one of these values except fsdk.TextPageCharInfoE_Unknown .
[in]font_sizeFont size. This should be a positive value.
[in]origin_xThe x-coordinate of the origin position.
[in]origin_yThe y-coordinate of the origin position.
[in]char_boxThe glyph bounding box in page space.
[in]char_outboxThe typographic (display and printing) bounding box in page space. The width is advance width, and the height is the sum of the ascent and descent.
[in]matrixThe matrix.
Returns
None.

◆ SetChar_box()

fsdk.TextPageCharInfo.SetChar_box (   value)

Set the glyph bounding box in page space.

Parameters
[in]valueThe glyph bounding box in page space.
Returns
None.

◆ SetChar_outbox()

fsdk.TextPageCharInfo.SetChar_outbox (   value)

Set the typographic(display and printing) bounding box in page space.

Parameters
[in]valueThe typographic(display and printing) bounding box in page space.
Returns
None.

◆ SetFlag()

fsdk.TextPageCharInfo.SetFlag (   value)

Set flags to indicate which properties of textpage character flag are meaningful.

Please refer to values starting from fsdk.TextPageCharInfoE_Normal and this should be one of these values.

Parameters
[in]valueFlags to indicate which properties of textpage character flag are meaningful.
Returns
None.

◆ SetFont()

fsdk.TextPageCharInfo.SetFont (   value)

Set a font for character.

Parameters
[in]valueA font for character.
Returns
None.

◆ SetFont_size()

fsdk.TextPageCharInfo.SetFont_size (   value)

Set font size for character.

This value would a positive value.

Parameters
[in]valueFont size for character.
Returns
None.

◆ SetMatrix()

fsdk.TextPageCharInfo.SetMatrix (   value)

Set the matrix of the character.

Parameters
[in]valueThe matrix of the character.
Returns
None.

◆ SetOrigin_x()

fsdk.TextPageCharInfo.SetOrigin_x (   value)

Set the x-coordinate of the origin position.

Parameters
[in]valueThe x-coordinate of the origin position.
Returns
None.

◆ SetOrigin_y()

fsdk.TextPageCharInfo.SetOrigin_y (   value)

Set the y-coordinate of the origin position.

Parameters
[in]valueThe y-coordinate of the origin position.
Returns
None.