Foxit PDF SDK
FSDK.TXT2PDFSettingData Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 constructor (page_width, page_height, page_margin, font, text_size, text_color, linespace, is_break_page)
 Constructor, with parameters. More...
 
 Set (page_width, page_height, page_margin, font, text_size, text_color, linespace, is_break_page)
 Set value. More...
 

Public Attributes

 font
 A font object.
 
 is_break_page
 Used to decide whether to insert a page break in converted PDF document when meeting character 0x0c.
 
 linespace
 Line spacing. If valid, it should be above 0.
 
 page_height
 Page height used for the converted PDF document.
 
 page_margin
 Page margin used for converted PDF document. More...
 
 page_width
 Page width used for the converted PDF document.
 
 text_color
 Font color.
 
 text_size
 Font size. If valid, it should be above 0.
 

Detailed Description

This class represents setting data used for converting TXT to PDF.

Member Function Documentation

◆ constructor()

FSDK.TXT2PDFSettingData.constructor ( page_width  ,
page_height  ,
page_margin  ,
font  ,
text_size  ,
text_color  ,
linespace  ,
is_break_page   
)

Constructor, with parameters.

Parameters
[in]page_widthPage width used for the converted PDF document.
[in]page_heightPage height used for the converted PDF document.
[in]page_marginPage margin used for converted PDF document.
[in]fontFont object used for converted PDF document.
[in]text_sizeFont size used for converted PDF document.
[in]text_colorFont color used for converted PDF document.
[in]linespaceLine space used for converted PDF document.
[in]is_break_pageUsed to decide whether to insert a page break in converted PDF document when meeting character 0x0c.
Returns
None.

◆ Set()

FSDK.TXT2PDFSettingData.Set ( page_width  ,
page_height  ,
page_margin  ,
font  ,
text_size  ,
text_color  ,
linespace  ,
is_break_page   
)

Set value.

Parameters
[in]page_widthPage width used for the converted PDF document.
[in]page_heightPage height used for the converted PDF document.
[in]page_marginPage margin used for converted PDF document.
[in]fontFont object used for converted PDF document.
[in]text_sizeFont size used for converted PDF document.
[in]text_colorFont color used for converted PDF document.
[in]linespaceLine space used for converted PDF document.
[in]is_break_pageUsed to decide whether to insert a page break in converted PDF document when meeting character 0x0c.
Returns
None.

Member Data Documentation

◆ page_margin

FSDK.TXT2PDFSettingData.page_margin

Page margin used for converted PDF document.

Note
This value does not represent a rectangle. It just defines the left margin, bottom margin, right margin and top margin of a PDF page.