Foxit PDF SDK
fs_convert.h
Go to the documentation of this file.
1 
15 #ifndef FS_CONVERT_H_
16 #define FS_CONVERT_H_
17 
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20 #include "pdf/fs_pdfpage.h"
21 
27 namespace foxit {
31 namespace addon {
35 namespace conversion {
37 class HTML2PDFSettingData FS_FINAL : public Object{
38  public:
44  typedef enum _HTML2PDFPageMode {
50 
56  typedef enum _HTML2PDFScalingMode {
64 
70  typedef enum _HTML2PDFEncodingFormat {
220 
226  typedef enum _HTML2PDFMediaStyle {
232 
233 
236  : page_width(0)
237  , page_height(0)
238  , is_to_page_scale(false)
239  , page_margin(0.0f, 0.0f, 0.0f, 0.0f)
240  , rotate_degrees(common::e_Rotation0)
241  , is_convert_link(false)
242  , is_generate_tag(false)
244  , to_generate_bookmarks(false)
247  , to_render_images(true)
249  , to_set_headerfooter(false)
250  , headerfooter_title(L"")
251  , headerfooter_url(L"")
252  , bookmark_root_name(L"")
253  , to_resize_objects(false)
254  , to_print_background(true)
255  , to_optimize_tag_tree(false)
257  , to_load_active_content(false)
258  , to_disable_sandbox(true)
259  , to_use_blacklist(false) {}
260 
300  const wchar_t* headerfooter_url, const wchar_t* bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree,
302  this->page_width = page_width;
303  this->page_height = page_height;
304  this->is_to_page_scale = is_to_page_scale;
305  this->page_margin = page_margin;
306  this->is_convert_link = is_convert_link;
307  this->rotate_degrees = rotate_degrees;
308  this->is_generate_tag = is_generate_tag;
309  this->page_mode = page_mode;
310  this->to_generate_bookmarks = to_generate_bookmarks;
311  this->scaling_mode = scaling_mode;
312  this->encoding_format = encoding_format;
313  this->to_render_images = to_render_images;
314  this->to_remove_underline_for_link = to_remove_underline_for_link;
315  this->to_set_headerfooter = to_set_headerfooter;
316  this->headerfooter_title = headerfooter_title;
317  this->headerfooter_url = headerfooter_url;
318  this->bookmark_root_name = bookmark_root_name;
319  this->to_resize_objects = to_resize_objects;
320  this->to_print_background = to_print_background;
321  this->to_optimize_tag_tree = to_optimize_tag_tree;
322  this->media_style = media_style;
323  this->to_load_active_content = to_load_active_content;
324  this->to_disable_sandbox = to_disable_sandbox;
325  this->to_use_blacklist = to_use_blacklist;
326  }
327 
336  page_width = data.page_width;
337  page_height = data.page_height;
339  page_margin = data.page_margin;
343  page_mode = data.page_mode;
345  scaling_mode = data.scaling_mode;
356  media_style = data.media_style;
360  return (*this);
361  }
362 
402  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,
404  this->page_width = page_width;
405  this->page_height = page_height;
406  this->is_to_page_scale = is_to_page_scale;
407  this->page_margin = page_margin;
408  this->is_convert_link = is_convert_link;
409  this->rotate_degrees = rotate_degrees;
410  this->is_generate_tag = is_generate_tag;
411  this->page_mode = page_mode;
412  this->to_generate_bookmarks = to_generate_bookmarks;
413  this->scaling_mode = scaling_mode;
414  this->encoding_format = encoding_format;
415  this->to_render_images = to_render_images;
416  this->to_remove_underline_for_link = to_remove_underline_for_link;
417  this->to_set_headerfooter = to_set_headerfooter;
418  this->headerfooter_title = headerfooter_title;
419  this->headerfooter_url = headerfooter_url;
420  this->bookmark_root_name = bookmark_root_name;
421  this->to_resize_objects = to_resize_objects;
422  this->to_print_background = to_print_background;
423  this->to_optimize_tag_tree = to_optimize_tag_tree;
424  this->media_style = media_style;
425  this->to_load_active_content = to_load_active_content;
426  this->to_disable_sandbox = to_disable_sandbox;
427  this->to_use_blacklist = to_use_blacklist;
428  }
429 
435  float page_width;
436 
444  float page_height;
445 
453 
461 
467 
470 
473 
479 
482 
488 
493 
496 
499 
502 
505 
508 
511 
514 
517 
520 
526 
535 
542 
570 };
571 
573 class TXT2PDFSettingData FS_FINAL : public Object {
574  public:
577  : page_width(0)
578  , page_height(0)
579  , text_size(0)
580  , text_color(0xFF000000)
581  , linespace(0)
582  , is_break_page(false) {
583  }
584 
600  ARGB text_color, float linespace, bool is_break_page) {
601  this->page_width = page_width;
602  this->page_height = page_height;
603  this->page_margin = page_margin;
604  this->font = font;
605  this->text_size = text_size;
606  this->text_color = text_color;
607  this->linespace = linespace;
608  this->is_break_page = is_break_page;
609  }
610 
619  page_width = data.page_width;
620  page_height = data.page_height;
621  page_margin = data.page_margin;
622  font = data.font;
623  text_size = data.text_size;
624  text_color = data.text_color;
625  linespace = data.linespace;
627  return (*this);
628  }
629 
645  ARGB text_color, float linespace, bool is_break_page) {
646  this->page_width = page_width;
647  this->page_height = page_height;
648  this->page_margin = page_margin;
649  this->font = font;
650  this->text_size = text_size;
651  this->text_color = text_color;
652  this->linespace = linespace;
653  this->is_break_page = is_break_page;
654  }
655 
657  float page_width;
658 
660  float page_height;
661 
669 
672 
674  float text_size;
675 
678 
680  float linespace;
681 
684 };
685 
692 class DWG2PDFSettingData FS_FINAL : public Object {
693  public:
699  typedef enum _DWG2PDFExportFlags {
727  e_FlagUseHLR = 0x0080,
745 
751  typedef enum _DWG2PDFExportHatchesType {
761 
767  typedef enum _DWG2PDFSearchableTextType {
775 
776 
781  : export_flags(1)
786  , is_active_layout(false)
787  , paper_width(0.0f)
788  , paper_height(0.0f) {}
789 
798  export_flags = data.export_flags;
804  output_title = data.output_title;
810  paper_width = data.paper_width;
811  paper_height = data.paper_height;
812  return (*this);
813  }
814 
821 
830 
841 
852 
863 
868 
873 
878 
883 
888 
893 
898 
906  float paper_width;
907 
916 };
917 
918 #if defined(_WIN32) || defined(_WIN64) || defined(__linux__)
919 
921 class Word2PDFSettingData FS_FINAL : public Object{
922  public:
929  typedef enum _ConvertOptimizeOption {
935 
942  typedef enum _ConvertContentOption {
948 
954  typedef enum _ConvertBookmarkOption {
969 
970 
973  : include_doc_props(false)
977  , convert_to_pdfa(false)
978  , disable_vba_code(false)
979  {}
980 
1007  bool convert_to_pdfa, bool disable_vba_code) {
1008  this->include_doc_props = include_doc_props;
1009  this->optimize_option = optimize_option;
1010  this->content_option = content_option;
1011  this->bookmark_option = bookmark_option;
1012  this->convert_to_pdfa = convert_to_pdfa;
1013  this->disable_vba_code = disable_vba_code;
1014  }
1015 
1030  return (*this);
1031  }
1032 
1061  bool convert_to_pdfa, bool disable_vba_code) {
1062  this->include_doc_props = include_doc_props;
1063  this->optimize_option = optimize_option;
1064  this->content_option = content_option;
1065  this->bookmark_option = bookmark_option;
1066  this->convert_to_pdfa = convert_to_pdfa;
1067  this->disable_vba_code = disable_vba_code;
1068  }
1069 
1078 
1086 
1094 
1102 
1111 
1120 };
1121 
1123 class Excel2PDFSettingData FS_FINAL : public Object{
1124  public:
1130  typedef enum _ConvertQuality {
1135  } ConvertQuality;
1136 
1142  typedef enum _ScaleType {
1151  } ScaleType;
1152 
1153 
1156  : include_doc_props(false)
1158  , ignore_print_area(true)
1160  , convert_to_pdfa(false)
1161  , disable_vba_code(false)
1162  {}
1163 
1184  this->include_doc_props = include_doc_props;
1185  this->quality = quality;
1186  this->ignore_print_area = ignore_print_area;
1187  this->scale_type = scale_type;
1188  this->convert_to_pdfa = convert_to_pdfa;
1189  this->disable_vba_code = disable_vba_code;
1190  }
1191 
1201  quality = data.quality;
1203  scale_type = data.scale_type;
1206  return (*this);
1207  }
1208 
1231  this->include_doc_props = include_doc_props;
1232  this->quality = quality;
1233  this->ignore_print_area = ignore_print_area;
1234  this->scale_type = scale_type;
1235  this->convert_to_pdfa = convert_to_pdfa;
1237  }
1238 
1247 
1254 
1263 
1270 
1279 
1288 };
1289 
1291 class PowerPoint2PDFSettingData FS_FINAL : public Object{
1292  public:
1298  typedef enum _ConvertIntent {
1303  } ConvertIntent;
1304 
1311  typedef enum _HandoutOrder {
1322  } HandoutOrder;
1323 
1329  typedef enum _OutputType {
1348  } OutputType;
1349 
1350 
1354  , frame_output_slides(false)
1357  , output_hidden_slides(false)
1358  , include_doc_props(false)
1359  , disable_vba_code(false)
1360  {}
1361 
1384  this->intent = intent;
1385  this->frame_output_slides = frame_output_slides;
1386  this->handout_order = handout_order;
1387  this->output_hidden_slides = output_hidden_slides;
1388  this->output_type = output_type;
1389  this->include_doc_props = include_doc_props;
1390  this->disable_vba_code = disable_vba_code;
1391  }
1392 
1401  intent = data.intent;
1403  output_type = data.output_type;
1408  return (*this);
1409  }
1410 
1435  this->intent = intent;
1436  this->frame_output_slides = frame_output_slides;
1437  this->output_type = output_type;
1438  this->handout_order = handout_order;
1439  this->output_hidden_slides = output_hidden_slides;
1440  this->include_doc_props = include_doc_props;
1441  this->disable_vba_code = disable_vba_code;
1442  }
1443 
1449 
1457 
1464 
1482 
1490 
1499 
1508 };
1509 #endif // #if (defined(_WIN32) || defined(_WIN64))
1510 
1512 class HTML2PDFRelatedResource FS_FINAL : public Object{
1513  public:
1518  }
1519 
1529  this->related_resource_file = related_resource_file;
1530  this->resource_file_relative_path = resource_file_relative_path;
1531  }
1532 
1543  return (*this);
1544  }
1545 
1548 
1556 };
1557 
1560 
1561 
1562 class OFDConvertParam FS_FINAL : public Object{
1563  public:
1566  :is_embed_font(false) {}
1567 
1573  OFDConvertParam(bool is_embed_font) {
1574  this->is_embed_font = is_embed_font;
1575  }
1576 
1584  void Set(bool is_embed_font) {
1585  this->is_embed_font = is_embed_font;
1586  }
1587 
1590 };
1591 
1602 class Convert FS_FINAL : public Base {
1603  public:
1621  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);
1622 
1641  static void FromHTML(const wchar_t* src_html, const wchar_t* engine_path, foxit::common::file::ReaderCallback* cookies_reader, const HTML2PDFSettingData& setting_data, const wchar_t* saved_pdf_path, int32 timeout);
1642 
1661  static void FromHTML(const wchar_t* src_html, const wchar_t* engine_path, foxit::common::file::ReaderCallback* cookies_reader, const HTML2PDFSettingData& setting_data, foxit::common::file::WriterCallback* saved_pdf_filestream, int32 timeout);
1662 
1683  static void FromHTML(foxit::common::file::ReaderCallback* src_html, const HTML2PDFRelatedResourceArray& html2pdf_related_resource_array, const wchar_t* engine_path, foxit::common::file::ReaderCallback* cookies_reader, const HTML2PDFSettingData& setting_data, foxit::common::file::WriterCallback* saved_pdf_filestream, int32 timeout);
1684 
1694  static void FromTXT(const wchar_t* src_txt, const wchar_t* saved_pdf_path, const TXT2PDFSettingData& setting_data);
1695 
1704  static void FromImage(const wchar_t* src_img, const wchar_t* saved_pdf_path);
1705 
1716  static void FromImage(foxit::common::file::ReaderCallback* file_reader, foxit::common::file::WriterCallback* saved_pdf_filestream);
1717 
1732  static bool FromDWG(const wchar_t* engine_path, const wchar_t* src_dwg_path, const wchar_t* saved_pdf_path,
1733  const DWG2PDFSettingData& settings);
1734 
1735 #if (defined(_WIN32) || defined(_WIN64))
1736 
1749  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);
1750 
1764  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);
1765 
1779  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);
1780 
1781 #elif defined(__linux__) && !(defined(__ANDROID__) || defined(_FS_IOS_) || defined(_SWIG_ANDROID_) || defined(_SWIG_IOS_))
1782 
1802  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);
1803 
1824  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);
1825 
1846  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);
1847 #endif
1848 
1871  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);
1872 
1873 #if (defined(_WIN32) || defined(_WIN64)) || defined(__linux__)
1874 
1886  static bool FromOFD(const wchar_t* src_ofd_path, const wchar_t* password, const wchar_t* saved_pdf_file_path, OFDConvertParam convert_param);
1887 
1900  static bool ToOFD(const wchar_t* src_pdf_path, const wchar_t* password, const wchar_t* saved_ofd_file_path, OFDConvertParam convert_param);
1901 #endif // #if (defined(_WIN32) || defined(_WIN64)) || defined(__linux__)
1902 
1903 };
1904 }
1905 }
1906 }
1907 #endif
Encoding foramt: "JIS".
Definition: fs_convert.h:98
bool include_doc_props
A boolean value which indicates whether to include Word document properties in the converted PDF docu...
Definition: fs_convert.h:1077
Searchable text type: Only text displayed with SHX font is searchable.
Definition: fs_convert.h:771
Searchable text type: Only text displayed with TTF font is searchable.
Definition: fs_convert.h:773
ConvertBookmarkOption bookmark_option
Bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted ...
Definition: fs_convert.h:1101
uint32 export_flags
The export flags used for the converted PDF document. Please refer to values starting from DWG2PDFSet...
Definition: fs_convert.h:820
Encoding foramt: "X-KDDI-Shift_JIS".
Definition: fs_convert.h:210
bool convert_to_pdfa
(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file....
Definition: fs_convert.h:1110
Encoding foramt: "EUC-CN".
Definition: fs_convert.h:104
Encoding foramt: "X-SoftBank-ISO-2022-JP".
Definition: fs_convert.h:218
Encoding foramt: "KOI8R".
Definition: fs_convert.h:118
Bit 9. Enable compression of internal PDF streams.
Definition: fs_convert.h:729
bool is_convert_link
Used to decide whether the web link should be converted or not.
Definition: fs_convert.h:469
HTML2PDFScalingMode
Enumeration for scaling mode used for converting HTML to PDF.
Definition: fs_convert.h:56
OutputType output_type
Output type used to specify which component (slides, handouts, notes pages, or an outline) of PowerPo...
Definition: fs_convert.h:1463
void Set(ConvertIntent intent, bool frame_output_slides, OutputType output_type, HandoutOrder handout_order, bool output_hidden_slides, bool include_doc_props, bool disable_vba_code)
Set value.
Definition: fs_convert.h:1433
Media style: screen. It means PDF page will be displayed in screen media style.
Definition: fs_convert.h:228
File writing interface.
Definition: fx_stream.h:453
DWG2PDFSearchableTextType
Enumeration for searchable text type used for converting DWG to PDF.
Definition: fs_convert.h:767
Encoding foramt: "VISUAL".
Definition: fs_convert.h:152
Page scaling: Scale. It means HTML content will be scaled to fit PDF page size. In this mode,...
Definition: fs_convert.h:60
Encoding foramt: "X-DoCoMo-Shift_JIS".
Definition: fs_convert.h:212
Hatches export type: Exports hatch as a set of triangles (vectorizer).
Definition: fs_convert.h:755
HandoutOrder
Enumeration for specifying the page layout order in which slides appear on converted handouts....
Definition: fs_convert.h:1311
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:644
DWG2PDFSearchableTextType searchable_text_type
The type of search text type.
Definition: fs_convert.h:862
ConvertOptimizeOption
Enumeration for optimize option (which specifies resolution and quality) for converting Word to PDF.
Definition: fs_convert.h:929
Encoding foramt: "X-TAM-ELANGO".
Definition: fs_convert.h:198
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
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:683
Encoding foramt: "Latin2".
Definition: fs_convert.h:76
Encoding foramt: "CP874".
Definition: fs_convert.h:124
Encoding foramt: "X-KDDI-ISO-2022-JP".
Definition: fs_convert.h:216
float page_height
Page height used for the converted PDF document.
Definition: fs_convert.h:660
bool to_optimize_tag_tree
Used to decide whether to optimize tag tree or not.
Definition: fs_convert.h:519
Encoding foramt: "CP1257".
Definition: fs_convert.h:142
foxit::WString output_creator
The creator for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:892
bool is_to_page_scale
Used to decide whether to scale the converted PDF page or not.
Definition: fs_convert.h:452
When converting PowerPoint in handouts type, convert handouts with consecutive slides displayed horiz...
Definition: fs_convert.h:1316
Header file for PDF document related definitions and classes.
float page_height
The page height used for the converted PDF document (unit is 1/72 inch).
Definition: fs_convert.h:444
bool disable_vba_code
A boolean value decide whether to disable the execution of vba code in the PowerPoint document.
Definition: fs_convert.h:1507
bool ignore_print_area
A boolean value which indicates whether to ignore any print area set when converting Excel document t...
Definition: fs_convert.h:1262
Searchable text type: No searchable text.
Definition: fs_convert.h:769
Media style: print. It means PDF page will be displayed in print media style.
Definition: fs_convert.h:230
Output type: handouts with four slide per handout page.
Definition: fs_convert.h:1343
Hatches export type: Exports hatch as a bitmap.
Definition: fs_convert.h:753
Encoding foramt: "EUC".
Definition: fs_convert.h:110
ConvertOptimizeOption optimize_option
Optimize option for covnerting Word to PDF, which specifies the resolution and quality of the convert...
Definition: fs_convert.h:1085
bool convert_to_pdfa
(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file....
Definition: fs_convert.h:1278
Encoding foramt: "X-SoftBank-Shift_JIS".
Definition: fs_convert.h:214
Bit 8. Determines whether software uses vector hidden-line removal for corresponding viewports.
Definition: fs_convert.h:727
Encoding foramt: "ISO-8859-11".
Definition: fs_convert.h:148
Encoding foramt: "BIG5_HKSCS".
Definition: fs_convert.h:164
bool to_generate_bookmarks
Used to decide whether bookmarks should be generated or not.
Definition: fs_convert.h:481
Encoding foramt: "TSCII".
Definition: fs_convert.h:168
ScaleType scale_type
Scale type for the Excel sheet when converting Excel document to PDF file. Please refer to values sta...
Definition: fs_convert.h:1269
ConvertIntent intent
Converting intent. Please refer to values starting from PowerPoint2PDFSettingData::e_ConvertIntentPri...
Definition: fs_convert.h:1448
Output type: handouts with one slide per handout page.
Definition: fs_convert.h:1337
DWG2PDFExportHatchesType
Enumeration for hatches export type used for converting DWG to PDF.
Definition: fs_convert.h:751
Encoding foramt: "BHASKAR".
Definition: fs_convert.h:180
bool is_generate_tag
Used to decide whether the tag should be generated or not.
Definition: fs_convert.h:472
Optimize option: convert for screen, which is a lower quality and results in a smaller file size.
Definition: fs_convert.h:933
File reading interface.
Definition: fx_stream.h:570
float page_width
The page width used for the converted PDF document (unit is 1/72 inch).
Definition: fs_convert.h:435
Encoding foramt: "TAM".
Definition: fs_convert.h:170
HTML2PDFSettingData()
Constructor.
Definition: fs_convert.h:235
WIDE STRING CLASS.
Definition: fx_string.h:1452
Bit 2. Enable TTF font text to geometry conversion.
Definition: fs_convert.h:707
Multiple page mode.
Definition: fs_convert.h:48
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:466
DWG2PDFExportHatchesType other_export_hatches_type
The type of other (non-solid) hatches export.
Definition: fs_convert.h:840
Bit 7. Enable embedding of TTF font program to PDF file. The TTF font will be reduced by removing unu...
Definition: fs_convert.h:723
bool frame_output_slides
A boolean value which indicates whether to frame output slides in the converted PDF document.
Definition: fs_convert.h:1456
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)
Convert a HTML format file or a URL of a Web page to a PDF file.
Bit 4. Enable simple geometry optimization (separated segments to one polyline, Bezier curve control ...
Definition: fs_convert.h:715
Excel2PDFSettingData()
Constructor.
Definition: fs_convert.h:1155
Encoding foramt: "Latin4".
Definition: fs_convert.h:80
bool is_active_layout
true means to export the active layout only, while false means not. Default value: false.
Definition: fs_convert.h:867
HTML2PDFEncodingFormat encoding_format
The HTML encoding format Please refer to values starting from HTML2PDFSettingData::e_EncodingFormatDe...
Definition: fs_convert.h:492
Encoding foramt: "Greek".
Definition: fs_convert.h:90
Encoding foramt: "UTF7".
Definition: fs_convert.h:178
Fit all rows of one sheet on one page.
Definition: fs_convert.h:1148
Encoding foramt: "HZ-GB-2312".
Definition: fs_convert.h:194
Output type: handouts with two slide per handout page.
Definition: fs_convert.h:1339
ScaleType
Enumeration for scaling type for each sheet in the Excel document for converting Excel to PDF.
Definition: fs_convert.h:1142
Encoding foramt: "GB18030".
Definition: fs_convert.h:162
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)
Convert a PowerPoint format file to a PDF file.
Encoding foramt: "CP852".
Definition: fs_convert.h:120
Encoding foramt: Default.The encoding format will be automatically detected in chromium.
Definition: fs_convert.h:72
bool disable_vba_code
A boolean value decide whether to disable the execution of vba code in the Word document.
Definition: fs_convert.h:1119
Hatches export type: Exports hatch as a PDF path (solid hatches only).
Definition: fs_convert.h:757
Encoding foramt: "ASCII-7-bit".
Definition: fs_convert.h:116
Encoding foramt: "JAGRAN".
Definition: fs_convert.h:174
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, bool to_disable_sandbox, bool to_use_blacklist)
Set value.
Definition: fs_convert.h:399
ConvertIntent
Enumeration for intent for converting PowerPoint to PDF.
Definition: fs_convert.h:1298
Optimize option: convert for print, which is higher quality and results in a larger file size.
Definition: fs_convert.h:931
ConvertBookmarkOption
Enumeration for bookmark option for for converting Word to PDF.
Definition: fs_convert.h:954
Encoding foramt: "EUC-JP".
Definition: fs_convert.h:94
Output type: handouts with three slide per handout page.
Definition: fs_convert.h:1341
Encoding foramt: "CP932".
Definition: fs_convert.h:126
bool include_doc_props
A boolean value which indicates whether to include Excel document properties in the converted PDF doc...
Definition: fs_convert.h:1246
float text_size
Font size. If valid, it should be above 0.
Definition: fs_convert.h:674
Output type: notes pages.
Definition: fs_convert.h:1333
Scaling mode: Fixed page with no scale. In this mode, the text size of HTML content will not be chang...
Definition: fs_convert.h:58
DWG2PDFExportFlags
Enumeration for flags of DWG to PDF export.
Definition: fs_convert.h:699
Encoding foramt: "X-TAM-WEBTAMIL".
Definition: fs_convert.h:208
static bool FromOFD(const wchar_t *src_ofd_path, const wchar_t *password, const wchar_t *saved_pdf_file_path, OFDConvertParam convert_param)
Convert OFD file to PDF file.
HTML2PDFMediaStyle media_style
The media style used for the converted PDF document. Please refer to values starting from HTML2PDFSet...
Definition: fs_convert.h:525
RectF page_margin
The page margin used for converted PDF document.
Definition: fs_convert.h:460
OutputType
Enumeration for output type for converting PowerPoint to PDF.
Definition: fs_convert.h:1329
Encoding foramt: "Unicode".
Definition: fs_convert.h:108
Encoding foramt: "CP866".
Definition: fs_convert.h:122
static bool FromDWG(const wchar_t *engine_path, const wchar_t *src_dwg_path, const wchar_t *saved_pdf_path, const DWG2PDFSettingData &settings)
Convert a DWG format file to a PDF file.
HTML2PDFPageMode
Enumeration for page mode used for converting HTML to PDF.
Definition: fs_convert.h:44
Encoding foramt: "KOI8U".
Definition: fs_convert.h:144
Encoding foramt: "CP1256".
Definition: fs_convert.h:140
Encoding foramt: "CP1250".
Definition: fs_convert.h:128
Encoding foramt: "TAB".
Definition: fs_convert.h:172
Page scaling: Enlarge. It means PDF page will be enlarged to HTML content size. In this mode,...
Definition: fs_convert.h:62
HTML2PDFScalingMode scaling_mode
The scaling mode used for the converted PDF document. Please refer to values starting from HTML2PDFSe...
Definition: fs_convert.h:487
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:210
bool is_embed_font
Whether to embed font in the converted file. true means to embed font in the converted file,...
Definition: fs_convert.h:1589
Intent: converted result file will be used for showing on screen.
Definition: fs_convert.h:1302
HTML2PDFEncodingFormat
Enumeration for encoding format used for converting HTML to PDF.
Definition: fs_convert.h:70
foxit::WString output_subject
The subject for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:882
Bit 10. Enable ASCIIHex encoding of internal PDF streams.
Definition: fs_convert.h:731
Encoding foramt: "CP1255".
Definition: fs_convert.h:138
Encoding foramt: "HTCHANAKYA".
Definition: fs_convert.h:182
Fit a sheet on one page.
Definition: fs_convert.h:1150
Encoding foramt: "CSN_369103".
Definition: fs_convert.h:154
Encoding foramt: "ISO-8859-8-I".
Definition: fs_convert.h:150
Fit all columns of one sheet on one page.
Definition: fs_convert.h:1146
Bit 15. Enable measuring scale in pdf.
Definition: fs_convert.h:743
HTML2PDFPageMode page_mode
The page mode used for the converting. Please refer to values starting from HTML2PDFSettingData::e_Pa...
Definition: fs_convert.h:478
Bit 1. Enable embedding of TTF(True Type Font) program to PDF file. The whole TTF font file will be e...
Definition: fs_convert.h:703
foxit::WString output_producer
The producer for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:897
Encoding foramt: "SJS".
Definition: fs_convert.h:96
bool to_use_blacklist
Used to decide whether to use blacklist or not.
Definition: fs_convert.h:569
bool to_set_headerfooter
Used to decide whether to set header-footer or not.
Definition: fs_convert.h:501
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)
Convert a PDF file to a XML format file.
foxit::WString output_keywords
The keywords for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:887
Encoding foramt: "UTF-32LE".
Definition: fs_convert.h:190
Excel2PDFSettingData(bool include_doc_props, ConvertQuality quality, bool ignore_print_area, ScaleType scale_type, bool convert_to_pdfa, bool disable_vba_code)
Constructor, with parameters.
Definition: fs_convert.h:1182
foxit::WString bookmark_root_name
The bookmark's root name.
Definition: fs_convert.h:510
bool to_print_background
Used to decide whether to print background or not.
Definition: fs_convert.h:516
Output type: handouts with six slide per handout page.
Definition: fs_convert.h:1345
DWG2PDFExportHatchesType gradient_export_hatches_type
The type of gradient hatches export.
Definition: fs_convert.h:851
TXT2PDFSettingData & operator=(const TXT2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:618
Encoding foramt: "UTF-32BE".
Definition: fs_convert.h:188
Do not create bookmark in converted PDF file.
Definition: fs_convert.h:956
Convert Word document without markup.
Definition: fs_convert.h:944
Word2PDFSettingData & operator=(const Word2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:1023
Intent: converted result file will be used for printing.
Definition: fs_convert.h:1300
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
RectF page_margin
Page margin used for converted PDF document.
Definition: fs_convert.h:668
bool to_disable_sandbox
Used to decide whether to disable sandbox or not.
Definition: fs_convert.h:541
Hatches export type: Exports hatch as a polygon (solid hatches only).
Definition: fs_convert.h:759
HandoutOrder handout_order
Handout order used to specify the page layout order in which slides appear on converted handouts....
Definition: fs_convert.h:1481
DWG2PDFSettingData()
Constructor, with parameters.
Definition: fs_convert.h:780
Encoding foramt: "CP1252".
Definition: fs_convert.h:132
common::Font font
A font object.
Definition: fs_convert.h:671
Encoding foramt: "ASCII".
Definition: fs_convert.h:74
Header file for common definitions and classes.
Bit 12. If enabled, layout geometry will be zoomed to paper size, else layout settings will be applie...
Definition: fs_convert.h:739
DWG2PDFSettingData & operator=(const DWG2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:797
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)
Convert a Word format file to a PDF file.
Encoding foramt: "BIG5".
Definition: fs_convert.h:100
void Set(bool include_doc_props, ConvertQuality quality, bool ignore_print_area, ScaleType scale_type, bool convert_to_pdfa)
Set value.
Definition: fs_convert.h:1229
Encoding foramt: "MACINTOSH".
Definition: fs_convert.h:176
bool output_hidden_slides
A boolean value which indicates whether to convert hidden slides to the converted PDF document.
Definition: fs_convert.h:1489
Create bookmarks in converted PDF file by using each heading of Word document.
Definition: fs_convert.h:962
Encoding foramt: "CP1254".
Definition: fs_convert.h:136
static void FromTXT(const wchar_t *src_txt, const wchar_t *saved_pdf_path, const TXT2PDFSettingData &setting_data)
Convert a TXT format file to a PDF file.
Encoding foramt: "X-TAM-TMNEWS".
Definition: fs_convert.h:206
Bit 5. If enabled, layer support will be added to PDF file (1.5 version required).
Definition: fs_convert.h:717
HTML2PDFSettingData & operator=(const HTML2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:335
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
float paper_height
The paper height used for the converted PDF document.
Definition: fs_convert.h:915
Definition: fs_basictypes.h:427
DWG2PDFExportHatchesType export_hatches_type
The type of solid hatches export.
Definition: fs_convert.h:829
static void FromImage(const wchar_t *src_img, const wchar_t *saved_pdf_path)
Convert a Image format file to a PDF file.
Word2PDFSettingData()
Constructor.
Definition: fs_convert.h:972
Encoding foramt: "X-TAM-LTTMBARANI".
Definition: fs_convert.h:200
OFDConvertParam()
Constructor.
Definition: fs_convert.h:1565
void Set(bool include_doc_props, ConvertOptimizeOption optimize_option, ConvertContentOption content_option, ConvertBookmarkOption bookmark_option, bool convert_to_pdfa, bool disable_vba_code)
Set value.
Definition: fs_convert.h:1059
Encoding foramt: "X-TAM-TBOOMIS".
Definition: fs_convert.h:204
Encoding foramt: "ISO-8859-13".
Definition: fs_convert.h:156
Header file for PDF page related definitions and classes.
Encoding foramt: "Hebrew".
Definition: fs_convert.h:92
bool to_render_images
Used to decide whether to render images or not.
Definition: fs_convert.h:495
ConvertContentOption content_option
Content option for covnerting Word to PDF, which specifies how much content of Word document is to be...
Definition: fs_convert.h:1093
PowerPoint2PDFSettingData()
Constructor.
Definition: fs_convert.h:1352
Encoding foramt: "Latin3".
Definition: fs_convert.h:78
ConvertQuality quality
Quality for covnerting Excel to PDF. Please refer to values starting from Excel2PDFSettingData::e_Con...
Definition: fs_convert.h:1253
Encoding foramt: "GBK".
Definition: fs_convert.h:160
Convert Word document with markup.
Definition: fs_convert.h:946
Definition: fs_common.h:1391
float paper_width
The paper width used for the converted PDF document.
Definition: fs_convert.h:906
No rotation.
Definition: fs_common.h:59
Rotation
Enumeration for rotation.
Definition: fs_common.h:57
Foxit namespace.
Definition: fs_taggedpdf.h:27
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, bool to_disable_sandbox, bool to_use_blacklist)
Constructor, with parameters.
Definition: fs_convert.h:297
Word2PDFSettingData(bool include_doc_props, ConvertOptimizeOption optimize_option, ConvertContentOption content_option, ConvertBookmarkOption bookmark_option, bool convert_to_pdfa, bool disable_vba_code)
Constructor, with parameters.
Definition: fs_convert.h:1005
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:599
bool to_load_active_content
Used to decide whether to load active content or not.
Definition: fs_convert.h:534
Encoding foramt: "ISO_2022_CN".
Definition: fs_convert.h:166
TXT2PDFSettingData()
Constructor.
Definition: fs_convert.h:576
Bit 13. Create linearized PDF file.
Definition: fs_convert.h:741
Encoding foramt: "X-TAM-SHREE".
Definition: fs_convert.h:202
Encoding foramt: "UTF-16LE".
Definition: fs_convert.h:186
Encoding foramt: "KSC".
Definition: fs_convert.h:106
bool to_resize_objects
Whether to enable the Javascripts related resizing of the objects during rendering process.
Definition: fs_convert.h:513
Encoding foramt: "ISO-2022-KR".
Definition: fs_convert.h:158
Encoding foramt: "Arabic".
Definition: fs_convert.h:88
When converting PowerPoint in handouts type, convert handouts with consecutive slides displayed verti...
Definition: fs_convert.h:1321
foxit::WString output_title
The title for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:872
Encoding foramt: "Latin6".
Definition: fs_convert.h:84
HTML2PDFMediaStyle
Enumeration for media style used for converting HTML to PDF.
Definition: fs_convert.h:226
Encoding foramt: "X-BINARYENC".
Definition: fs_convert.h:192
Encoding foramt: "GB".
Definition: fs_convert.h:102
#define NULL
The null-pointer value.
Definition: fx_system.h:780
static bool ToOFD(const wchar_t *src_pdf_path, const wchar_t *password, const wchar_t *saved_ofd_file_path, OFDConvertParam convert_param)
Convert PDF file to OFD file.
Output type: outline view.
Definition: fs_convert.h:1335
Bit 11. Enable hyperlinks export.
Definition: fs_convert.h:733
foxit::WString headerfooter_title
The header-footer title which is content for center header.
Definition: fs_convert.h:504
Encoding foramt: "CP1253".
Definition: fs_convert.h:134
float page_width
Page width used for the converted PDF document.
Definition: fs_convert.h:657
bool disable_vba_code
A boolean value decide whether to disable the execution of vba code in the Excel document.
Definition: fs_convert.h:1287
void Set(bool is_embed_font)
Set value.
Definition: fs_convert.h:1584
bool to_remove_underline_for_link
Used to decide whether to remove underline decoration for link.
Definition: fs_convert.h:498
bool include_doc_props
A boolean value which indicates whether to include PowerPoint document properties in the converted PD...
Definition: fs_convert.h:1498
PowerPoint2PDFSettingData(ConvertIntent intent, bool frame_output_slides, OutputType output_type, HandoutOrder handout_order, bool output_hidden_slides, bool include_doc_props, bool disable_vba_code)
Constructor, with parameters.
Definition: fs_convert.h:1382
Definition: fs_convert.h:1602
Output type: handouts with nine slide per handout page.
Definition: fs_convert.h:1347
foxit::WString headerfooter_url
The header-footer url which is content for left footer.
Definition: fs_convert.h:507
Encoding foramt: "Latin5".
Definition: fs_convert.h:82
Definition: fs_convert.h:1562
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)
Convert an Excel format file to a PDF file.
ARGB text_color
Font color.
Definition: fs_convert.h:677
Create bookmarks in converted PDF file by using each bookmarks of Word document.
Definition: fs_convert.h:967
Bit 3. Enable SHX font text to geometry conversion.
Definition: fs_convert.h:711
Encoding foramt: "ISO-8859-5".
Definition: fs_convert.h:86
Encoding foramt: "BIG5-CP950".
Definition: fs_convert.h:114
foxit::WString output_author
The author for the output PDF document, an empty string will be used as default.
Definition: fs_convert.h:877
Encoding foramt: "UTF-16BE".
Definition: fs_convert.h:184
Bit 6. If enabled, invisible layers will be added to PDF file (1.5 version required).
Definition: fs_convert.h:719
float linespace
Line spacing. If valid, it should be above 0.
Definition: fs_convert.h:680
ConvertQuality
Enumeration for quality for converting Excel to PDF.
Definition: fs_convert.h:1130
Encoding foramt: "CNS".
Definition: fs_convert.h:112
Output type: slides.
Definition: fs_convert.h:1331
ConvertContentOption
Enumeration for content option which specifies how much content of Word document is to be converted t...
Definition: fs_convert.h:942
Encoding foramt: "CP1251".
Definition: fs_convert.h:130
OFDConvertParam(bool is_embed_font)
Constructor, with parameters.
Definition: fs_convert.h:1573
Encoding foramt: "ISO-8859-15".
Definition: fs_convert.h:146
Excel2PDFSettingData & operator=(const Excel2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:1199
Definition: fx_coordinates.h:771
Encoding foramt: "X-UTF8UTF8".
Definition: fs_convert.h:196
PowerPoint2PDFSettingData & operator=(const PowerPoint2PDFSettingData &data)
Assign operator.
Definition: fs_convert.h:1400