Foxit PDF SDK
fsdk.Word2PDFSettingData Class Reference

Public Member Functions

def GetBookmark_option ()
 Get bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted PDF file, and the type of bookmarks. More...
 
def GetContent_option ()
 Get content option for covnerting Word to PDF, which specifies how much content of Word document is to be converted to PDF file. More...
 
def GetConvert_to_pdfa ()
 Get (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. More...
 
def GetDisable_vba_code ()
 Get a boolean value decide whether to disable the execution of vba code in the Word document. More...
 
def GetInclude_doc_props ()
 Get a boolean value which indicates whether to include Word document properties in the converted PDF document. More...
 
def GetOptimize_option ()
 Get optimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document. More...
 
def Set (include_doc_props, optimize_option, content_option, bookmark_option, convert_to_pdfa, disable_vba_code)
 Set value. More...
 
def SetBookmark_option (value)
 Set bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted PDF file, and the type of bookmarks. More...
 
def SetContent_option (value)
 Set content option for covnerting Word to PDF, which specifies how much content of Word document is to be converted to PDF file. More...
 
def SetConvert_to_pdfa (value)
 Set (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. More...
 
def SetDisable_vba_code (value)
 Set a boolean value decide whether to disable the execution of vba code in the Word document. More...
 
def SetInclude_doc_props (value)
 Set a boolean value which indicates whether to include Word document properties in the converted PDF document. More...
 
def SetOptimize_option (value)
 Set optimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document. More...
 

Detailed Description

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

Member Function Documentation

◆ GetBookmark_option()

fsdk.Word2PDFSettingData.GetBookmark_option ( )

Get bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted PDF file, and the type of bookmarks.

Returns
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 fsdk.Word2PDFSettingDataE_ConvertBookmarkOptionNone and this should be one of these values.

◆ GetContent_option()

fsdk.Word2PDFSettingData.GetContent_option ( )

Get content option for covnerting Word to PDF, which specifies how much content of Word document is to be converted to PDF file.

Returns
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 fsdk.Word2PDFSettingDataE_ConvertContentOptionOnlyContent and this should be one of these values.

◆ GetConvert_to_pdfa()

fsdk.Word2PDFSettingData.GetConvert_to_pdfa ( )

Get (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file.

true means to convert Word document to a PDF/A file.
false means to convert Word document to a common file.

Returns
(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.

◆ GetDisable_vba_code()

fsdk.Word2PDFSettingData.GetDisable_vba_code ( )

Get a boolean value decide whether to disable the execution of vba code in the Word document.

true means to disable the vba code, while false means not. Default value:false.
This flag is only supported on Windows platforms.

Returns
A boolean value decide whether to disable the execution of vba code in the Word document.

◆ GetInclude_doc_props()

fsdk.Word2PDFSettingData.GetInclude_doc_props ( )

Get 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.

Returns
A boolean value which indicates whether to include Word document properties in the converted PDF document.

◆ GetOptimize_option()

fsdk.Word2PDFSettingData.GetOptimize_option ( )

Get optimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document.

Returns
Optimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document. Please refer to values starting from fsdk.Word2PDFSettingDataE_ConvertOptimizeOptionForPrint and this should be one of these values.

◆ Set()

def fsdk.Word2PDFSettingData.Set (   include_doc_props,
  optimize_option,
  content_option,
  bookmark_option,
  convert_to_pdfa,
  disable_vba_code 
)

Set value.

Parameters
[in]include_doc_propsA boolean value which indicates whether to include Word document properties in the converted PDF document.
[in]optimize_optionOptimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document. Please refer to values starting from fsdk.Word2PDFSettingDataE_ConvertOptimizeOptionForPrint and this should be one of these values.
[in]content_optionContent 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 fsdk.Word2PDFSettingDataE_ConvertContentOptionOnlyContent and this should be one of these values.
[in]bookmark_optionBookmark 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 fsdk.Word2PDFSettingDataE_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.
[in]disable_vba_codeA boolean value decide whether to disable the execution of vba code in the Word document.
Returns
None.

◆ SetBookmark_option()

fsdk.Word2PDFSettingData.SetBookmark_option (   value)

Set bookmark option for covnerting Word to PDF, which specifies whether to export bookmarks to converted PDF file, and the type of bookmarks.

Parameters
[in]valueBookmark 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 fsdk.Word2PDFSettingDataE_ConvertBookmarkOptionNone and this should be one of these values.
Returns
None.

◆ SetContent_option()

fsdk.Word2PDFSettingData.SetContent_option (   value)

Set content option for covnerting Word to PDF, which specifies how much content of Word document is to be converted to PDF file.

Parameters
[in]valueContent 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 fsdk.Word2PDFSettingDataE_ConvertContentOptionOnlyContent and this should be one of these values.
Returns
None.

◆ SetConvert_to_pdfa()

fsdk.Word2PDFSettingData.SetConvert_to_pdfa (   value)

Set (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file.

true means to convert Word document to a PDF/A file.
false means to convert Word document to a common file.

Parameters
[in]value(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.
Returns
None.

◆ SetDisable_vba_code()

fsdk.Word2PDFSettingData.SetDisable_vba_code (   value)

Set a boolean value decide whether to disable the execution of vba code in the Word document.

true means to disable the vba code, while false means not. Default value:false.
This flag is only supported on Windows platforms.

Parameters
[in]valueA boolean value decide whether to disable the execution of vba code in the Word document.
Returns
None.

◆ SetInclude_doc_props()

fsdk.Word2PDFSettingData.SetInclude_doc_props (   value)

Set 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.

Parameters
[in]valueA boolean value which indicates whether to include Word document properties in the converted PDF document.
Returns
None.

◆ SetOptimize_option()

fsdk.Word2PDFSettingData.SetOptimize_option (   value)

Set optimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document.

Parameters
[in]valueOptimize option for covnerting Word to PDF, which specifies the resolution and quality of the converted PDF document. Please refer to values starting from fsdk.Word2PDFSettingDataE_ConvertOptimizeOptionForPrint and this should be one of these values.
Returns
None.