Foxit PDF SDK
FSDK.TextPageCharInfo Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 constructor (font, flag, font_size, origin_x, origin_y, char_box, char_outbox, matrix)
 Constructor, with parameters. More...
 
 Set (font, flag, font_size, origin_x, origin_y, char_box, char_outbox, matrix)
 Set value. More...
 

Public Attributes

 char_box
 The glyph bounding box in page space.
 
 char_outbox
 The typographic(display and printing) bounding box in page space.
 
 flag
 Flags to indicate which properties of textpage character flag are meaningful. More...
 
 font
 A font for character.
 
 font_size
 Font size for character. More...
 
 matrix
 The matrix of the character.
 
 origin_x
 The x-coordinate of the origin position.
 
 origin_y
 The y-coordinate of the origin position.
 

Static Public Attributes

static e_ComboWord
 Character flag: ComboWord.
 
static e_Generated
 Character flag: Generated.
 
static e_Hyphen
 Character flag: Hyphen.
 
static e_Normal
 Character flag: Normal.
 
static e_Unknown
 Enumeration for PDF textpage character flag. More...
 
static e_UnUnicode
 Character flag: UnUnicode.
 

Detailed Description

This class represents textpage character information.

Member Function Documentation

◆ constructor()

FSDK.TextPageCharInfo.constructor ( font  ,
flag  ,
font_size  ,
origin_x  ,
origin_y  ,
char_box  ,
char_outbox  ,
matrix   
)

Constructor, with parameters.

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.TextPageCharInfo.e_Normal and this should be one of these values except FSDK.TextPageCharInfo.e_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.

◆ Set()

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.TextPageCharInfo.e_Normal and this should be one of these values except FSDK.TextPageCharInfo.e_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.

Member Data Documentation

◆ e_Unknown

FSDK.TextPageCharInfo.e_Unknown
static

Enumeration for PDF textpage character flag.

Values of this enumeration should be used alone.

Character flag: Unknown.

◆ flag

FSDK.TextPageCharInfo.flag

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

Please refer to values starting from FSDK.TextPageCharInfo.e_Normal and this should be one of these values.

◆ font_size

FSDK.TextPageCharInfo.font_size

Font size for character.

This value would a positive value.