Go to the documentation of this file.
35 namespace conversion {
44 typedef enum _HTML2PDFPageMode {
56 typedef enum _HTML2PDFScalingMode {
70 typedef enum _HTML2PDFEncodingFormat {
226 typedef enum _HTML2PDFMediaStyle {
639 #if defined(_WIN32) || defined(_WIN64) || defined(__linux__)
642 class Word2PDFSettingData FS_FINAL :
public Object{
650 typedef enum _ConvertOptimizeOption {
652 e_ConvertOptimizeOptionForPrint = 0,
654 e_ConvertOptimizeOptionForOnScreen = 1
655 } ConvertOptimizeOption;
663 typedef enum _ConvertContentOption {
665 e_ConvertContentOptionOnlyContent = 0,
667 e_ConvertContentOptionWithMarkup = 1
668 } ConvertContentOption;
675 typedef enum _ConvertBookmarkOption {
677 e_ConvertBookmarkOptionNone = 0,
683 e_ConvertBookmarkOptionUseHeadings = 1,
688 e_ConvertBookmarkOptionUseWordBookmark = 2
689 } ConvertBookmarkOption;
693 Word2PDFSettingData()
694 : include_doc_props(false)
695 , optimize_option(Word2PDFSettingData::e_ConvertOptimizeOptionForPrint)
696 , content_option(Word2PDFSettingData::e_ConvertContentOptionOnlyContent)
697 , bookmark_option(Word2PDFSettingData::e_ConvertBookmarkOptionNone)
698 , convert_to_pdfa(false)
724 Word2PDFSettingData(
bool include_doc_props, ConvertOptimizeOption optimize_option,
725 ConvertContentOption content_option, ConvertBookmarkOption bookmark_option,
726 bool convert_to_pdfa) {
727 this->include_doc_props = include_doc_props;
728 this->optimize_option = optimize_option;
729 this->content_option = content_option;
730 this->bookmark_option = bookmark_option;
731 this->convert_to_pdfa = convert_to_pdfa;
741 Word2PDFSettingData &operator = (
const Word2PDFSettingData& data) {
742 include_doc_props = data.include_doc_props;
743 optimize_option = data.optimize_option;
744 content_option = data.content_option;
745 bookmark_option = data.bookmark_option;
746 convert_to_pdfa = data.convert_to_pdfa;
775 void Set(
bool include_doc_props, ConvertOptimizeOption optimize_option,
776 ConvertContentOption content_option, ConvertBookmarkOption bookmark_option,
777 bool convert_to_pdfa) {
778 this->include_doc_props = include_doc_props;
779 this->optimize_option = optimize_option;
780 this->content_option = content_option;
781 this->bookmark_option = bookmark_option;
782 this->convert_to_pdfa = convert_to_pdfa;
792 bool include_doc_props;
800 ConvertOptimizeOption optimize_option;
808 ConvertContentOption content_option;
816 ConvertBookmarkOption bookmark_option;
825 bool convert_to_pdfa;
829 class Excel2PDFSettingData FS_FINAL :
public Object{
836 typedef enum _ConvertQuality {
838 e_ConvertQualityStandard = 0,
840 e_ConvertQualityMinimum = 1
848 typedef enum _ScaleType {
852 e_ScaleTypeFitAllColumns = 1,
854 e_ScaleTypeFitAllRows = 2,
856 e_ScaleTypeFitSheet = 3
861 Excel2PDFSettingData()
862 : include_doc_props(false)
863 , quality(Excel2PDFSettingData::e_ConvertQualityStandard)
864 , ignore_print_area(true)
865 , scale_type(Excel2PDFSettingData::e_ScaleTypeNone)
866 , convert_to_pdfa(false)
886 Excel2PDFSettingData(
bool include_doc_props, ConvertQuality quality,
bool ignore_print_area,
887 ScaleType scale_type,
bool convert_to_pdfa) {
888 this->include_doc_props = include_doc_props;
889 this->quality = quality;
890 this->ignore_print_area = ignore_print_area;
891 this->scale_type = scale_type;
892 this->convert_to_pdfa = convert_to_pdfa;
902 Excel2PDFSettingData &operator = (
const Excel2PDFSettingData& data) {
903 include_doc_props = data.include_doc_props;
904 quality = data.quality;
905 ignore_print_area = data.ignore_print_area;
906 scale_type = data.scale_type;
907 convert_to_pdfa = data.convert_to_pdfa;
930 void Set(
bool include_doc_props, ConvertQuality quality,
bool ignore_print_area,
931 ScaleType scale_type,
bool convert_to_pdfa) {
932 this->include_doc_props = include_doc_props;
933 this->quality = quality;
934 this->ignore_print_area = ignore_print_area;
935 this->scale_type = scale_type;
936 this->convert_to_pdfa = convert_to_pdfa;
946 bool include_doc_props;
953 ConvertQuality quality;
962 bool ignore_print_area;
969 ScaleType scale_type;
978 bool convert_to_pdfa;
982 class PowerPoint2PDFSettingData FS_FINAL :
public Object{
989 typedef enum _ConvertIntent {
991 e_ConvertIntentPrint = 0,
993 e_ConvertIntentScreen = 1
1002 typedef enum _HandoutOrder {
1007 e_HandoutOrderHorizontalFirst = 0,
1012 e_HandoutOrderVerticalFirst = 1
1020 typedef enum _OutputType {
1024 e_OutputNotesPages = 2,
1026 e_OutputOutline = 3,
1028 e_OutputOneSlideHandouts = 4,
1030 e_OutputTwoSlideHandouts = 5,
1032 e_OutputThreeSlideHandouts = 6,
1034 e_OutputFourSlideHandouts = 7,
1036 e_OutputSixSlideHandouts = 8,
1038 e_OutputNineSlideHandouts = 9
1043 PowerPoint2PDFSettingData()
1044 : intent(PowerPoint2PDFSettingData::e_ConvertIntentPrint)
1045 , frame_output_slides(false)
1046 , output_type(PowerPoint2PDFSettingData::e_OutputSlides)
1047 , handout_order(PowerPoint2PDFSettingData::e_HandoutOrderVerticalFirst)
1048 , output_hidden_slides(false)
1049 , include_doc_props(false)
1071 PowerPoint2PDFSettingData(ConvertIntent intent,
bool frame_output_slides, OutputType output_type, HandoutOrder handout_order,
1072 bool output_hidden_slides,
bool include_doc_props) {
1073 this->intent = intent;
1074 this->frame_output_slides = frame_output_slides;
1075 this->handout_order = handout_order;
1076 this->output_hidden_slides = output_hidden_slides;
1077 this->output_type = output_type;
1078 this->include_doc_props = include_doc_props;
1088 PowerPoint2PDFSettingData &operator = (
const PowerPoint2PDFSettingData& data) {
1089 intent = data.intent;
1090 frame_output_slides = data.frame_output_slides;
1091 output_type = data.output_type;
1092 handout_order = data.handout_order;
1093 output_hidden_slides = data.output_hidden_slides;
1094 include_doc_props = data.include_doc_props;
1119 void Set(ConvertIntent intent,
bool frame_output_slides, OutputType output_type, HandoutOrder handout_order,
1120 bool output_hidden_slides,
bool include_doc_props) {
1121 this->intent = intent;
1122 this->frame_output_slides = frame_output_slides;
1123 this->output_type = output_type;
1124 this->handout_order = handout_order;
1125 this->output_hidden_slides = output_hidden_slides;
1126 this->include_doc_props = include_doc_props;
1133 ConvertIntent intent;
1141 bool frame_output_slides;
1148 OutputType output_type;
1166 HandoutOrder handout_order;
1174 bool output_hidden_slides;
1183 bool include_doc_props;
1185 #endif // #if (defined(_WIN32) || defined(_WIN64))
1264 static void FromHTML(
const wchar_t* src_html,
const wchar_t* engine_path,
const wchar_t* cookies_path,
const HTML2PDFSettingData& setting_data,
const wchar_t* saved_pdf_path,
int32 timeout);
1337 static void FromTXT(
const wchar_t* src_txt,
const wchar_t* saved_pdf_path,
const TXT2PDFSettingData& setting_data);
1339 #if (defined(_WIN32) || defined(_WIN64))
1353 static void FromWord(
const wchar_t* src_word_file_path,
const wchar_t* src_file_password,
const wchar_t* saved_pdf_path,
const Word2PDFSettingData& setting_data);
1368 static void FromExcel(
const wchar_t* src_excel_file_path,
const wchar_t* src_file_password,
const wchar_t* saved_pdf_path,
const Excel2PDFSettingData& setting_data);
1383 static void FromPowerPoint(
const wchar_t* src_ppt_file_path,
const wchar_t* src_file_password,
const wchar_t* saved_pdf_path,
const PowerPoint2PDFSettingData& setting_data);
1385 #elif defined(__linux__) && !(defined(__ANDROID__) || defined(_FS_IOS_) || defined(_SWIG_ANDROID_) || defined(_SWIG_IOS_))
1405 static void FromWord(
const wchar_t* src_word_file_path,
const wchar_t* src_file_password,
const wchar_t* saved_pdf_path,
const wchar_t* engine_path,
const Word2PDFSettingData& setting_data);
1426 static void FromExcel(
const wchar_t* src_excel_file_path,
const wchar_t* src_file_password,
const wchar_t* saved_pdf_path,
const wchar_t* engine_path,
const Excel2PDFSettingData& setting_data);
1447 static void FromPowerPoint(
const wchar_t* src_ppt_file_path,
const wchar_t* src_file_password,
const wchar_t* saved_pdf_path,
const wchar_t* engine_path,
const PowerPoint2PDFSettingData& setting_data);
1472 static bool ToXML(
const wchar_t* src_pdf_path,
const wchar_t* src_file_password,
const wchar_t* saved_xml_path,
const wchar_t* saved_image_folder_path,
bool is_force_to_tagged_pdf);
HTML2PDFMediaStyle media_style
The media style used for the converted PDF document. Please refer to values starting from HTML2PDFSet...
Definition: fs_convert.h:513
Encoding foramt: Default.The encoding format will be automatically detected in chromium.
Definition: fs_convert.h:72
Encoding foramt: "CP866".
Definition: fs_convert.h:122
Encoding foramt: "GB18030".
Definition: fs_convert.h:162
File writing interface.
Definition: fx_stream.h:451
Media style: screen. It means PDF page will be displayed in screen media style.
Definition: fs_convert.h:228
void Set(float page_width, float page_height, bool is_to_page_scale, RectF page_margin, bool is_convert_link, common::Rotation rotate_degrees, bool is_generate_tag, HTML2PDFPageMode page_mode, bool to_generate_bookmarks, HTML2PDFScalingMode scaling_mode, HTML2PDFEncodingFormat encoding_format, bool to_render_images, bool to_remove_underline_for_link, bool to_set_headerfooter, const wchar_t *headerfooter_title, const wchar_t *headerfooter_url, const wchar_t *bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree, HTML2PDFMediaStyle media_style, bool to_load_active_content)
Set value.
Definition: fs_convert.h:389
Encoding foramt: "Hebrew".
Definition: fs_convert.h:92
Encoding foramt: "X-TAM-ELANGO".
Definition: fs_convert.h:198
Page scaling: Scale. It means HTML content will be scaled to fit PDF page size.
Definition: fs_convert.h:60
HTML2PDFScalingMode
Enumeration for scaling mode used for converting HTML to PDF.
Definition: fs_convert.h:56
Page scaling: Enlarge. It means PDF page will be enlarged to HTML content size.
Definition: fs_convert.h:62
void Set(float page_width, float page_height, RectF page_margin, const common::Font &font, float text_size, ARGB text_color, float linespace, bool is_break_page)
Set value.
Definition: fs_convert.h:597
Encoding foramt: "VISUAL".
Definition: fs_convert.h:152
Encoding foramt: "ISO-2022-KR".
Definition: fs_convert.h:158
CFX_Object Object
Object type.
Definition: fs_basictypes.h:217
No rotation.
Definition: fs_common.h:59
bool is_convert_link
Used to decide whether the web link should be converted or not.
Definition: fs_convert.h:457
float page_width
The page width used for the converted PDF document (unit is 1/72 inch).
Definition: fs_convert.h:423
Encoding foramt: "CSN_369103".
Definition: fs_convert.h:154
Encoding foramt: "EUC-JP".
Definition: fs_convert.h:94
Encoding foramt: "HTCHANAKYA".
Definition: fs_convert.h:182
Encoding foramt: "ASCII-7-bit".
Definition: fs_convert.h:116
Encoding foramt: "CP1252".
Definition: fs_convert.h:132
Media style: print. It means PDF page will be displayed in print media style.
Definition: fs_convert.h:230
Header file for common definitions and classes.
bool is_to_page_scale
Used to decide whether to scale the converted PDF page or not.
Definition: fs_convert.h:440
Encoding foramt: "KOI8R".
Definition: fs_convert.h:118
Encoding foramt: "CP1254".
Definition: fs_convert.h:136
float page_height
Page height used for the converted PDF document.
Definition: fs_convert.h:613
File reading interface.
Definition: fx_stream.h:566
Encoding foramt: "ISO-8859-11".
Definition: fs_convert.h:148
Encoding foramt: "BIG5".
Definition: fs_convert.h:100
Encoding foramt: "JIS".
Definition: fs_convert.h:98
RectF page_margin
The page margin used for converted PDF document.
Definition: fs_convert.h:448
common::Rotation rotate_degrees
The rotation degree used for the converted PDF page.Please refer to values starting from common::e_Ro...
Definition: fs_convert.h:454
Encoding foramt: "GBK".
Definition: fs_convert.h:160
Definition: fs_convert.h:37
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
Encoding foramt: "CP1253".
Definition: fs_convert.h:134
Encoding foramt: "X-BINARYENC".
Definition: fs_convert.h:192
Encoding foramt: "ISO-8859-15".
Definition: fs_convert.h:146
foxit::WString headerfooter_url
The header-footer url which is content for left footer.
Definition: fs_convert.h:495
Encoding foramt: "CP1255".
Definition: fs_convert.h:138
HTML2PDFPageMode
Enumeration for page mode used for converting HTML to PDF.
Definition: fs_convert.h:44
Encoding foramt: "UTF-16LE".
Definition: fs_convert.h:186
Encoding foramt: "X-SoftBank-ISO-2022-JP".
Definition: fs_convert.h:218
Encoding foramt: "X-TAM-SHREE".
Definition: fs_convert.h:202
Encoding foramt: "KSC".
Definition: fs_convert.h:106
bool to_remove_underline_for_link
Used to decide whether to remove underline decoration for link.
Definition: fs_convert.h:486
Encoding foramt: "BHASKAR".
Definition: fs_convert.h:180
Encoding foramt: "CP1251".
Definition: fs_convert.h:130
Encoding foramt: "X-DoCoMo-Shift_JIS".
Definition: fs_convert.h:212
Encoding foramt: "KOI8U".
Definition: fs_convert.h:144
bool to_load_active_content
Used to decide whether to load active content or not.
Definition: fs_convert.h:522
HTML2PDFSettingData()
Constructor.
Definition: fs_convert.h:235
Encoding foramt: "X-KDDI-ISO-2022-JP".
Definition: fs_convert.h:216
Encoding foramt: "GB".
Definition: fs_convert.h:102
bool to_optimize_tag_tree
Used to decide whether to optimize tag tree or not.
Definition: fs_convert.h:507
Encoding foramt: "MACINTOSH".
Definition: fs_convert.h:176
Encoding foramt: "Unicode".
Definition: fs_convert.h:108
Encoding foramt: "X-TAM-TBOOMIS".
Definition: fs_convert.h:204
RectF page_margin
Page margin used for converted PDF document.
Definition: fs_convert.h:621
Encoding foramt: "Latin5".
Definition: fs_convert.h:82
Encoding foramt: "TAM".
Definition: fs_convert.h:170
Encoding foramt: "TAB".
Definition: fs_convert.h:172
foxit::WString headerfooter_title
The header-footer title which is content for center header.
Definition: fs_convert.h:492
Encoding foramt: "CP1256".
Definition: fs_convert.h:140
Encoding foramt: "Arabic".
Definition: fs_convert.h:88
Encoding foramt: "X-UTF8UTF8".
Definition: fs_convert.h:196
Encoding foramt: "ISO-8859-5".
Definition: fs_convert.h:86
bool to_print_background
Used to decide whether to print background or not.
Definition: fs_convert.h:504
Encoding foramt: "CP852".
Definition: fs_convert.h:120
Encoding foramt: "X-TAM-WEBTAMIL".
Definition: fs_convert.h:208
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Encoding foramt: "CP1250".
Definition: fs_convert.h:128
common::Font font
A font object.
Definition: fs_convert.h:624
Encoding foramt: "TSCII".
Definition: fs_convert.h:168
Encoding foramt: "JAGRAN".
Definition: fs_convert.h:174
Encoding foramt: "CP1257".
Definition: fs_convert.h:142
Header file for PDF page related definitions and classes.
bool to_render_images
Used to decide whether to render images or not.
Definition: fs_convert.h:483
float text_size
Font size. If valid, it should be above 0.
Definition: fs_convert.h:627
Scaling mode: Fixed page with no scale.
Definition: fs_convert.h:58
Encoding foramt: "UTF-32BE".
Definition: fs_convert.h:188
bool to_set_headerfooter
Used to decide whether to set header-footer or not.
Definition: fs_convert.h:489
Foxit namespace.
Definition: fs_taggedpdf.h:27
Encoding foramt: "BIG5-CP950".
Definition: fs_convert.h:114
Encoding foramt: "X-SoftBank-Shift_JIS".
Definition: fs_convert.h:214
Multiple page mode.
Definition: fs_convert.h:48
foxit::WString bookmark_root_name
The bookmark's root name.
Definition: fs_convert.h:498
Encoding foramt: "X-KDDI-Shift_JIS".
Definition: fs_convert.h:210
TXT2PDFSettingData & operator=(const TXT2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:571
Encoding foramt: "HZ-GB-2312".
Definition: fs_convert.h:194
Encoding foramt: "UTF-16BE".
Definition: fs_convert.h:184
TXT2PDFSettingData()
Constructor.
Definition: fs_convert.h:529
Encoding foramt: "ISO-8859-8-I".
Definition: fs_convert.h:150
Encoding foramt: "CP874".
Definition: fs_convert.h:124
HTML2PDFPageMode page_mode
The page mode used for the converting. Please refer to values starting from HTML2PDFSettingData::e_Pa...
Definition: fs_convert.h:466
Header file for PDF document related definitions and classes.
TXT2PDFSettingData(float page_width, float page_height, RectF page_margin, const common::Font &font, float text_size, ARGB text_color, float linespace, bool is_break_page)
Constructor, with parameters.
Definition: fs_convert.h:552
#define NULL
The null-pointer value.
Definition: fx_system.h:780
Encoding foramt: "X-TAM-TMNEWS".
Definition: fs_convert.h:206
Definition: fx_coordinates.h:771
Encoding foramt: "X-TAM-LTTMBARANI".
Definition: fs_convert.h:200
Encoding foramt: "EUC-CN".
Definition: fs_convert.h:104
Encoding foramt: "EUC".
Definition: fs_convert.h:110
Single page mode.
Definition: fs_convert.h:46
ARGB text_color
Font color.
Definition: fs_convert.h:630
HTML2PDFSettingData & operator=(const HTML2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:329
Encoding foramt: "Latin6".
Definition: fs_convert.h:84
Encoding foramt: "ISO_2022_CN".
Definition: fs_convert.h:166
float linespace
Line spacing. If valid, it should be above 0.
Definition: fs_convert.h:633
HTML2PDFScalingMode scaling_mode
The scaling mode used for the converted PDF document. Please refer to values starting from HTML2PDFSe...
Definition: fs_convert.h:475
Encoding foramt: "Greek".
Definition: fs_convert.h:90
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
HTML2PDFEncodingFormat encoding_format
The HTML encoding format Please refer to values starting from HTML2PDFSettingData::e_EncodingFormatDe...
Definition: fs_convert.h:480
Encoding foramt: "CP932".
Definition: fs_convert.h:126
bool to_generate_bookmarks
Used to decide whether bookmarks should be generated or not.
Definition: fs_convert.h:469
Definition: fs_common.h:1344
Encoding foramt: "CNS".
Definition: fs_convert.h:112
Encoding foramt: "Latin2".
Definition: fs_convert.h:76
Encoding foramt: "UTF-32LE".
Definition: fs_convert.h:190
Encoding foramt: "Latin3".
Definition: fs_convert.h:78
HTML2PDFEncodingFormat
Enumeration for encoding format used for converting HTML to PDF.
Definition: fs_convert.h:70
WIDE STRING CLASS.
Definition: fx_string.h:1452
HTML2PDFMediaStyle
Enumeration for media style used for converting HTML to PDF.
Definition: fs_convert.h:226
Encoding foramt: "SJS".
Definition: fs_convert.h:96
Encoding foramt: "ISO-8859-13".
Definition: fs_convert.h:156
bool is_generate_tag
Used to decide whether the tag should be generated or not.
Definition: fs_convert.h:460
float page_height
The page height used for the converted PDF document (unit is 1/72 inch).
Definition: fs_convert.h:432
bool is_break_page
Used to decide whether to insert a page break in converted PDF document when meeting character 0x0c.
Definition: fs_convert.h:636
Definition: fs_convert.h:526
Encoding foramt: "Latin4".
Definition: fs_convert.h:80
Encoding foramt: "ASCII".
Definition: fs_convert.h:74
float page_width
Page width used for the converted PDF document.
Definition: fs_convert.h:610
Definition: fs_basictypes.h:413
bool to_resize_objects
Whether to enable the Javascripts related resizing of the objects during rendering process.
Definition: fs_convert.h:501
Definition: fs_convert.h:1245
Encoding foramt: "BIG5_HKSCS".
Definition: fs_convert.h:164
Encoding foramt: "UTF7".
Definition: fs_convert.h:178
HTML2PDFSettingData(float page_width, float page_height, bool is_to_page_scale, RectF page_margin, bool is_convert_link, common::Rotation rotate_degrees, bool is_generate_tag, HTML2PDFPageMode page_mode, bool to_generate_bookmarks, HTML2PDFScalingMode scaling_mode, HTML2PDFEncodingFormat encoding_format, bool to_render_images, bool to_remove_underline_for_link, bool to_set_headerfooter, const wchar_t *headerfooter_title, const wchar_t *headerfooter_url, const wchar_t *bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree, HTML2PDFMediaStyle media_style, bool to_load_active_content)
Constructor, with parameters.
Definition: fs_convert.h:293
@2023 Foxit Software Incorporated. All rights reserved.