Foxit PDF SDK
fsdk.TXT2PDFSettingData Class Reference

Public Member Functions

def GetFont ()
 Get a font object. More...
 
def GetIs_break_page ()
 Get used to decide whether to insert a page break in converted PDF document when meeting character 0x0c. More...
 
def GetLinespace ()
 Get line spacing. More...
 
def GetPage_height ()
 Get page height used for the converted PDF document. More...
 
def GetPage_margin ()
 Get page margin used for converted PDF document. More...
 
def GetPage_width ()
 Get page width used for the converted PDF document. More...
 
def GetText_color ()
 Get font color. More...
 
def GetText_size ()
 Get font size. More...
 
def Set (page_width, page_height, page_margin, font, text_size, text_color, linespace, is_break_page)
 Set value.
More...
 
def SetFont (value)
 Set a font object. More...
 
def SetIs_break_page (value)
 Set used to decide whether to insert a page break in converted PDF document when meeting character 0x0c. More...
 
def SetLinespace (value)
 Set line spacing. More...
 
def SetPage_height (value)
 Set page height used for the converted PDF document. More...
 
def SetPage_margin (value)
 Set page margin used for converted PDF document. More...
 
def SetPage_width (value)
 Set page width used for the converted PDF document. More...
 
def SetText_color (value)
 Set font color. More...
 
def SetText_size (value)
 Set font size. More...
 

Detailed Description

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

Member Function Documentation

◆ GetFont()

fsdk.TXT2PDFSettingData.GetFont ( )

Get a font object.

Returns
A font object.

◆ GetIs_break_page()

fsdk.TXT2PDFSettingData.GetIs_break_page ( )

Get used to decide whether to insert a page break in converted PDF document when meeting character 0x0c.

Returns
Used to decide whether to insert a page break in converted PDF document when meeting character 0x0c.

◆ GetLinespace()

fsdk.TXT2PDFSettingData.GetLinespace ( )

Get line spacing.

Returns
Line spacing. If valid, it should be above 0.

◆ GetPage_height()

fsdk.TXT2PDFSettingData.GetPage_height ( )

Get page height used for the converted PDF document.

Returns
Page height used for the converted PDF document.

◆ GetPage_margin()

fsdk.TXT2PDFSettingData.GetPage_margin ( )

Get 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.
Returns
Page margin used for converted PDF document.

◆ GetPage_width()

fsdk.TXT2PDFSettingData.GetPage_width ( )

Get page width used for the converted PDF document.

Returns
Page width used for the converted PDF document.

◆ GetText_color()

fsdk.TXT2PDFSettingData.GetText_color ( )

Get font color.

Returns
Font color.

◆ GetText_size()

fsdk.TXT2PDFSettingData.GetText_size ( )

Get font size.

Returns
Font size. If valid, it should be above 0.

◆ Set()

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

◆ SetFont()

fsdk.TXT2PDFSettingData.SetFont (   value)

Set a font object.

Parameters
[in]valueA font object.
Returns
None.

◆ SetIs_break_page()

fsdk.TXT2PDFSettingData.SetIs_break_page (   value)

Set used to decide whether to insert a page break in converted PDF document when meeting character 0x0c.

Parameters
[in]valueUsed to decide whether to insert a page break in converted PDF document when meeting character 0x0c.
Returns
None.

◆ SetLinespace()

fsdk.TXT2PDFSettingData.SetLinespace (   value)

Set line spacing.

Parameters
[in]valueLine spacing. If valid, it should be above 0.
Returns
None.

◆ SetPage_height()

fsdk.TXT2PDFSettingData.SetPage_height (   value)

Set page height used for the converted PDF document.

Parameters
[in]valuePage height used for the converted PDF document.
Returns
None.

◆ SetPage_margin()

fsdk.TXT2PDFSettingData.SetPage_margin (   value)

Set 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.
Parameters
[in]valuePage margin used for converted PDF document.
Returns
None.

◆ SetPage_width()

fsdk.TXT2PDFSettingData.SetPage_width (   value)

Set page width used for the converted PDF document.

Parameters
[in]valuePage width used for the converted PDF document.
Returns
None.

◆ SetText_color()

fsdk.TXT2PDFSettingData.SetText_color (   value)

Set font color.

Parameters
[in]valueFont color.
Returns
None.

◆ SetText_size()

fsdk.TXT2PDFSettingData.SetText_size (   value)

Set font size.

Parameters
[in]valueFont size. If valid, it should be above 0.
Returns
None.