Foxit PDF SDK
foxit.addon.conversion.HTML2PDFSettingData Class Reference

Inherits SystemIDisposable.

Public Types

enum  HTML2PDFPageMode { HTML2PDFPageMode.e_PageModeSinglePage = 0, HTML2PDFPageMode.e_PageModeMultiplePage = 1 }
 Enumeration for page mode used for converting HTML to PDF.
More...
 

Public Member Functions

 HTML2PDFSettingData ()
 Constructor.

 
 HTML2PDFSettingData (float page_width, float page_height, bool is_to_page_scale, RectF page_margin, bool is_convert_link, Rotation rotate_degrees, bool is_generate_tag, HTML2PDFSettingData.HTML2PDFPageMode page_mode)
 Constructor, with parameters.
More...
 
void Set (float page_width, float page_height, bool is_to_page_scale, RectF page_margin, bool is_convert_link, Rotation rotate_degrees, bool is_generate_tag, HTML2PDFSettingData.HTML2PDFPageMode page_mode)
 Set value.
More...
 

Properties

bool is_convert_link [get, set]
 Used to decide whether the web link should be coverted or not.

 
bool is_generate_tag [get, set]
 Used to decide whether the tag should be generated or not.

 
bool is_to_page_scale [get, set]
 Used to decide whether to scale the coverted PDF page or not.

 
float page_height [get, set]
 The page height used for the coverted PDF document.
More...
 
RectFpage_margin [get, set]
 The page margin used for coverted PDF document.
More...
 
HTML2PDFSettingData.HTML2PDFPageMode page_mode [get, set]
 The page mode used for the converting. Please refer to values starting from foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage and this should be one of these values.

 
float page_width [get, set]
 The page width used for the coverted PDF document.

 
Rotation rotate_degrees [get, set]
 The rotation degree used for the coverted PDF page.Please refer to values starting from foxit.common.Rotation.e_Rotation0 and this should be one of these values.

 

Detailed Description

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

Member Enumeration Documentation

◆ HTML2PDFPageMode

Enumeration for page mode used for converting HTML to PDF.

Values of this enumeration should be used alone.

Enumerator
e_PageModeSinglePage 

Single page mode.

e_PageModeMultiplePage 

Multiple page mode.

Constructor & Destructor Documentation

◆ HTML2PDFSettingData()

foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFSettingData ( float  page_width,
float  page_height,
bool  is_to_page_scale,
RectF  page_margin,
bool  is_convert_link,
Rotation  rotate_degrees,
bool  is_generate_tag,
HTML2PDFSettingData.HTML2PDFPageMode  page_mode 
)
inline

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 foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage 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 foxit.common.Rotation.e_Rotation0 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 foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage and this should be one of these values.
Returns
None.

Member Function Documentation

◆ Set()

void foxit.addon.conversion.HTML2PDFSettingData.Set ( float  page_width,
float  page_height,
bool  is_to_page_scale,
RectF  page_margin,
bool  is_convert_link,
Rotation  rotate_degrees,
bool  is_generate_tag,
HTML2PDFSettingData.HTML2PDFPageMode  page_mode 
)
inline

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 foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage 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 foxit.common.Rotation.e_Rotation0 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 foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage and this should be one of these values.
Returns
None.

Property Documentation

◆ page_height

float foxit.addon.conversion.HTML2PDFSettingData.page_height
getset

The page height used for the coverted PDF document.

Note
The page height would be ignored if page mode foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage is used.

◆ page_margin

RectF foxit.addon.conversion.HTML2PDFSettingData.page_margin
getset

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.