Foxit PDF SDK
|
Inherits SystemIDisposable.
Public Types | |
enum | ConvertBookmarkOption { ConvertBookmarkOption.e_ConvertBookmarkOptionNone = 0, ConvertBookmarkOption.e_ConvertBookmarkOptionUseHeadings = 1, ConvertBookmarkOption.e_ConvertBookmarkOptionUseWordBookmark = 2 } |
Enumeration for bookmark option for for converting Word to PDF. More... | |
enum | ConvertContentOption { ConvertContentOption.e_ConvertContentOptionOnlyContent = 0, ConvertContentOption.e_ConvertContentOptionWithMarkup = 1 } |
Enumeration for content option which specifies how much content of Word document is to be converted to PDF document. More... | |
enum | ConvertOptimizeOption { ConvertOptimizeOption.e_ConvertOptimizeOptionForPrint = 0, ConvertOptimizeOption.e_ConvertOptimizeOptionForOnScreen = 1 } |
Enumeration for optimize option (which specifies resolution and quality) for converting Word to PDF. More... | |
Public Member Functions | |
Word2PDFSettingData () | |
Constructor. | |
Word2PDFSettingData (bool include_doc_props, Word2PDFSettingData.ConvertOptimizeOption optimize_option, Word2PDFSettingData.ConvertContentOption content_option, Word2PDFSettingData.ConvertBookmarkOption bookmark_option, bool convert_to_pdfa) | |
Constructor, with parameters. More... | |
void | Set (bool include_doc_props, Word2PDFSettingData.ConvertOptimizeOption optimize_option, Word2PDFSettingData.ConvertContentOption content_option, Word2PDFSettingData.ConvertBookmarkOption bookmark_option, bool convert_to_pdfa) |
Set value. More... | |
Properties | |
Word2PDFSettingData.ConvertBookmarkOption | bookmark_option [get, set] |
Bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted PDF file, and the type of bookmarks. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertBookmarkOption.e_ConvertBookmarkOptionNone and this should be one of these values. | |
Word2PDFSettingData.ConvertContentOption | content_option [get, set] |
Content option for covnerting Word to PDF, which specifies how much content of Word document is to be converted to PDF file. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertContentOption.e_ConvertContentOptionOnlyContent and this should be one of these values. | |
bool | convert_to_pdfa [get, set] |
(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. Currently, this is useless and Foxit PDF SDK will treated as false. More... | |
bool | include_doc_props [get, set] |
A boolean value which indicates whether to include Word document properties in the converted PDF document. More... | |
Word2PDFSettingData.ConvertOptimizeOption | optimize_option [get, set] |
Optimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertOptimizeOption.e_ConvertOptimizeOptionForPrint and this should be one of these values. | |
This class represents setting data used for converting Word to PDF.
Enumeration for bookmark option for for converting Word to PDF.
Values of this enumeration should be used alone.
Enumeration for content option which specifies how much content of Word document is to be converted to PDF document.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
e_ConvertContentOptionOnlyContent |
Convert Word document without markup. |
e_ConvertContentOptionWithMarkup |
Convert Word document with markup. |
Enumeration for optimize option (which specifies resolution and quality) for converting Word to PDF.
Values of this enumeration should be used alone.
|
inline |
Constructor, with parameters.
[in] | include_doc_props | A boolean value which indicates whether to include Word document properties in the converted PDF document. |
[in] | optimize_option | Optimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertOptimizeOption.e_ConvertOptimizeOptionForPrint and this should be one of these values. |
[in] | content_option | Content option for covnerting Word to PDF, which specifies how much content of Word document is to be converted to PDF file. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertContentOption.e_ConvertContentOptionOnlyContent and this should be one of these values. |
[in] | bookmark_option | Bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted PDF file, and the type of bookmarks. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertBookmarkOption.e_ConvertBookmarkOptionNone and this should be one of these values. |
[in] | convert_to_pdfa | (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. Currently, this is useless and Foxit PDF SDK will treated as false. |
|
inline |
Set value.
[in] | include_doc_props | A boolean value which indicates whether to include Word document properties in the converted PDF document. |
[in] | optimize_option | Optimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertOptimizeOption.e_ConvertOptimizeOptionForPrint and this should be one of these values. |
[in] | content_option | Content option for covnerting Word to PDF, which specifies how much content of Word document is to be converted to PDF file. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertContentOption.e_ConvertContentOptionOnlyContent and this should be one of these values. |
[in] | bookmark_option | Bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted PDF file, and the type of bookmarks. Please refer to values starting from foxit.addon.conversion.Word2PDFSettingData.ConvertBookmarkOption.e_ConvertBookmarkOptionNone and this should be one of these values. |
[in] | convert_to_pdfa | (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. Currently, this is useless and Foxit PDF SDK will treated as false. |
|
getset |
(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. Currently, this is useless and Foxit PDF SDK will treated as false.
true means to convert Word document to a PDF/A file.
false means to convert Word document to a common file.
|
getset |
A boolean value which indicates whether to include Word document properties in the converted PDF document.
true means to include Word document properties in the converted PDF document.
false means not to include Word document properties in the converted PDF document.