Foxit PDF SDK
FSHTML2PDFSettingData Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithPage_width:page_height:is_to_page_scale:page_margin:is_convert_link:rotate_degrees:is_generate_tag:page_mode:
 Constructor, with parameters.
More...
 
(void) - set:page_height:is_to_page_scale:page_margin:is_convert_link:rotate_degrees:is_generate_tag:page_mode:
 Set value.
More...
 

Properties

BOOL is_convert_link
 Used to decide whether the web link should be coverted or not.

 
BOOL is_generate_tag
 Used to decide whether the tag should be generated or not.

 
BOOL is_to_page_scale
 Used to decide whether to scale the coverted PDF page or not.

 
float page_height
 The page height used for the coverted PDF document.
More...
 
FSRectFpage_margin
 The page margin used for coverted PDF document.
More...
 
FSHTML2PDFSettingDataHTML2PDFPageMode page_mode
 The page mode used for the converting. Please refer to values starting from FSHTML2PDFSettingDataPageModeSinglePage and this should be one of these values.

 
float page_width
 The page width used for the coverted PDF document.

 
FSRotation rotate_degrees
 The rotation degree used for the coverted PDF page.Please refer to values starting from FSRotation0 and this should be one of these values.

 

Detailed Description

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

Method Documentation

◆ initWithPage_width:page_height:is_to_page_scale:page_margin:is_convert_link:rotate_degrees:is_generate_tag:page_mode:()

- (id) initWithPage_width: (float)  page_width
page_height: (float)  page_height
is_to_page_scale: (BOOL)  is_to_page_scale
page_margin: (FSRectF*)  page_margin
is_convert_link: (BOOL)  is_convert_link
rotate_degrees: (FSRotation rotate_degrees
is_generate_tag: (BOOL)  is_generate_tag
page_mode: (FSHTML2PDFSettingDataHTML2PDFPageMode page_mode 

Constructor, with parameters.

Parameters
[in]page_widthThe page width used for the coverted PDF document.
[in]page_heightThe page height used for the coverted PDF document. This would be ignored if page mode FSHTML2PDFSettingDataPageModeSinglePage is used.
[in]is_to_page_scaleUsed to decide whether to scale the coverted PDF page or not.
[in]page_marginThe page margin used for coverted PDF document.
[in]is_convert_linkUsed to decide whether the web link should be coverted or not.
[in]rotate_degreesThe rotation degree used for the coverted PDF page.Please refer to values starting from FSRotation0 and this should be one of these values.
[in]is_generate_tagUsed to decide whether the tag should be generated or not.
[in]page_modeThe page mode used for the converting.. Please refer to values starting from FSHTML2PDFSettingDataPageModeSinglePage and this should be one of these values.
Returns
None.

◆ set:page_height:is_to_page_scale:page_margin:is_convert_link:rotate_degrees:is_generate_tag:page_mode:()

- (void) set: (float)  page_width
page_height: (float)  page_height
is_to_page_scale: (BOOL)  is_to_page_scale
page_margin: (FSRectF*)  page_margin
is_convert_link: (BOOL)  is_convert_link
rotate_degrees: (FSRotation rotate_degrees
is_generate_tag: (BOOL)  is_generate_tag
page_mode: (FSHTML2PDFSettingDataHTML2PDFPageMode page_mode 

Set value.

Parameters
[in]page_widthThe page width used for the coverted PDF document.
[in]page_heightThe page height used for the coverted PDF document. This would be ignored if page mode FSHTML2PDFSettingDataPageModeSinglePage is used.
[in]is_to_page_scaleUsed to decide whether to scale the coverted PDF page or not.
[in]page_marginThe page margin used for coverted PDF document.
[in]is_convert_linkUsed to decide whether the web link should be coverted or not.
[in]rotate_degreesThe rotation degree used for the coverted PDF page.Please refer to values starting from FSRotation0 and this should be one of these values.
[in]is_generate_tagUsed to decide whether the tag should be generated or not.
[in]page_modeThe page mode used for the converting.. Please refer to values starting from FSHTML2PDFSettingDataPageModeSinglePage and this should be one of these values.
Returns
None.

Property Documentation

◆ page_height

- (float) page_height
readwritenonatomicassign

The page height used for the coverted PDF document.

Note
The page height would be ignored if page mode FSHTML2PDFSettingDataPageModeSinglePage is used.

◆ page_margin

- (FSRectF *) page_margin
readwritenonatomicweak

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