Foxit PDF SDK
FoxitPDFSDKPython3.TXT2PDFSettingData Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def TXT2PDFSettingData ()
 Constructor. More...
 
def Set (page_width, page_height, page_margin, font, text_size, text_color, linespace, is_break_page)
 Set value. More...
 

Static Public Attributes

 font = _swig_property(_fsdk.TXT2PDFSettingData_font_get, _fsdk.TXT2PDFSettingData_font_set)
 A font object.
 
 is_break_page = _swig_property(_fsdk.TXT2PDFSettingData_is_break_page_get, _fsdk.TXT2PDFSettingData_is_break_page_set)
 Used to decide whether to insert a page break in converted PDF document when meeting character 0x0c.
 
 linespace = _swig_property(_fsdk.TXT2PDFSettingData_linespace_get, _fsdk.TXT2PDFSettingData_linespace_set)
 Line spacing. If valid, it should be above 0.
 
 page_height = _swig_property(_fsdk.TXT2PDFSettingData_page_height_get, _fsdk.TXT2PDFSettingData_page_height_set)
 Page height used for the converted PDF document.
 
 page_margin = _swig_property(_fsdk.TXT2PDFSettingData_page_margin_get, _fsdk.TXT2PDFSettingData_page_margin_set)
 Page margin used for converted PDF document. More...
 
 page_width = _swig_property(_fsdk.TXT2PDFSettingData_page_width_get, _fsdk.TXT2PDFSettingData_page_width_set)
 Page width used for the converted PDF document.
 
 text_color = _swig_property(_fsdk.TXT2PDFSettingData_text_color_get, _fsdk.TXT2PDFSettingData_text_color_set)
 Font color.
 
 text_size = _swig_property(_fsdk.TXT2PDFSettingData_text_size_get, _fsdk.TXT2PDFSettingData_text_size_set)
 Font size. If valid, it should be above 0.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ TXT2PDFSettingData()

def FoxitPDFSDKPython3.TXT2PDFSettingData.TXT2PDFSettingData ( )

Constructor.

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.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.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

FoxitPDFSDKPython3.TXT2PDFSettingData.page_margin = _swig_property(_fsdk.TXT2PDFSettingData_page_margin_get, _fsdk.TXT2PDFSettingData_page_margin_set)
static

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.