Foxit PDF SDK
FSTXT2PDFSettingData Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithPage_width:page_height:page_margin:font:text_size:text_color:linespace:is_break_page:
 Constructor, with parameters.
More...
 
(void) - set:page_height:page_margin:font:text_size:text_color:linespace:is_break_page:
 Set value.
More...
 

Properties

FSFontfont
 A font object.

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

 
float linespace
 Line spacing. If valid, it should be above 0.

 
float page_height
 Page height used for the coverted PDF document.

 
FSRectFpage_margin
 Page margin used for coverted PDF document.
More...
 
float page_width
 Page width used for the coverted PDF document.

 
unsigned int text_color
 Font color.

 
float text_size
 Font size. If valid, it should be above 0.

 

Detailed Description

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

Method Documentation

◆ initWithPage_width:page_height:page_margin:font:text_size:text_color:linespace:is_break_page:()

- (id) initWithPage_width: (float)  page_width
page_height: (float)  page_height
page_margin: (FSRectF*)  page_margin
font: (FSFont*)  font
text_size: (float)  text_size
text_color: (unsigned int)  text_color
linespace: (float)  linespace
is_break_page: (BOOL)  is_break_page 

Constructor, with parameters.

Parameters
[in]page_widthPage width used for the coverted PDF document.
[in]page_heightPage height used for the coverted PDF document.
[in]page_marginPage margin used for coverted PDF document.
[in]fontFont object used for coverted PDF document.
[in]text_sizeFont size used for coverted PDF document.
[in]text_colorFont color used for coverted PDF document.
[in]linespaceLine space used for coverted 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:page_height:page_margin:font:text_size:text_color:linespace:is_break_page:()

- (void) set: (float)  page_width
page_height: (float)  page_height
page_margin: (FSRectF*)  page_margin
font: (FSFont*)  font
text_size: (float)  text_size
text_color: (unsigned int)  text_color
linespace: (float)  linespace
is_break_page: (BOOL)  is_break_page 

Set value.

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

Property Documentation

◆ page_margin

- (FSRectF *) page_margin
readwritenonatomicweak

Page margin used for coverted PDF document.

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