Foxit PDF Conversion SDK
foxit.conversion.office2pdf.Office2PDFSettingData Class Reference

Inherits SystemIDisposable.

Public Member Functions

 Office2PDFSettingData ()
 Constructor.
 
 Office2PDFSettingData (string resource_folder_path, bool is_embed_font, Word2PDFSettingData word_setting_data, Excel2PDFSettingData excel_setting_data)
 Constructor, with parameters. More...
 
void Set (string resource_folder_path, bool is_embed_font, Word2PDFSettingData word_setting_data, Excel2PDFSettingData excel_setting_data)
 Set value. More...
 

Properties

Excel2PDFSettingDataexcel_setting_data [get, set]
 A setting data object that used for converting Excel format documents to PDF format documents. More...
 
bool is_embed_font [get, set]
 A boolean value which indicates whether to embed font in the converted file,Default value: false. More...
 
string resource_folder_path [get, set]
 A valid path of a folder which contains resource data files. This should not be an empty string. More...
 
Word2PDFSettingDataword_setting_data [get, set]
 A setting data object that used for converting Word format documents to PDF format documents. More...
 

Detailed Description

This class represents setting data used for converting Office(Word, Excel or PowerPoint) to PDF format file.

Constructor & Destructor Documentation

◆ Office2PDFSettingData()

foxit.conversion.office2pdf.Office2PDFSettingData.Office2PDFSettingData ( string  resource_folder_path,
bool  is_embed_font,
Word2PDFSettingData  word_setting_data,
Excel2PDFSettingData  excel_setting_data 
)
inline

Constructor, with parameters.

Parameters
[in]resource_folder_pathA valid path of a folder which contains resource data files. This should not be an empty string. These resource data files are used to simulate the pdf format document typesetting process during conversion. They are offered in the "res/office2pdf" folder of the Foxit PDF Conversion SDK package.
[in]is_embed_fonttrue means to embed font in the converted file, while false means not.
[in]word_setting_dataA setting data object that used for converting Word format documents to PDF format documents.
[in]excel_setting_dataA setting data object that used for converting Excel format documents to PDF format documents.

Member Function Documentation

◆ Set()

void foxit.conversion.office2pdf.Office2PDFSettingData.Set ( string  resource_folder_path,
bool  is_embed_font,
Word2PDFSettingData  word_setting_data,
Excel2PDFSettingData  excel_setting_data 
)
inline

Set value.

Parameters
[in]resource_folder_pathA valid path of a folder which contains resource data files. This should not be an empty string. These resource data files are used to simulate the pdf format document typesetting process during conversion. They are offered in the "res/office2pdf" folder of the Foxit PDF Conversion SDK package.
[in]is_embed_fonttrue means to embed font in the converted file, while false means not.
[in]word_setting_dataA setting data object that used for converting Word format documents to PDF format documents.
[in]excel_setting_dataA setting data object that used for converting Excel format documents to PDF format documents.
Returns
None.

Property Documentation

◆ excel_setting_data

Excel2PDFSettingData foxit.conversion.office2pdf.Office2PDFSettingData.excel_setting_data
getset

A setting data object that used for converting Excel format documents to PDF format documents.

This setting is only vaild for the conversion of Excel documents to PDF format documents. For more details, please refer to class Excel2PDFSettingData .

◆ is_embed_font

bool foxit.conversion.office2pdf.Office2PDFSettingData.is_embed_font
getset

A boolean value which indicates whether to embed font in the converted file,Default value: false.

true means to embed font in the converted file, while false means not.

◆ resource_folder_path

string foxit.conversion.office2pdf.Office2PDFSettingData.resource_folder_path
getset

A valid path of a folder which contains resource data files. This should not be an empty string.

These resource data files are used to simulate the pdf format document typesetting process during conversion. They are offered in the "res/office2pdf" folder of the Foxit PDF Conversion SDK package.

◆ word_setting_data

Word2PDFSettingData foxit.conversion.office2pdf.Office2PDFSettingData.word_setting_data
getset

A setting data object that used for converting Word format documents to PDF format documents.

This setting is only vaild for the conversion of Word documents to PDF format documents. For more details, please refer to class Word2PDFSettingData .