Foxit PDF SDK
fsdk.PowerPoint2PDFSettingData Class Reference

Public Member Functions

def GetDisable_vba_code ()
 Get a boolean value decide whether to disable the execution of vba code in the PowerPoint document. More...
 
def GetFrame_output_slides ()
 Get a boolean value which indicates whether to frame output slides in the converted PDF document. More...
 
def GetHandout_order ()
 Get handout order used to specify the page layout order in which slides appear on converted handouts. More...
 
def GetInclude_doc_props ()
 Get a boolean value which indicates whether to include PowerPoint document properties in the converted PDF document. More...
 
def GetIntent ()
 Get converting intent. More...
 
def GetOutput_hidden_slides ()
 Get a boolean value which indicates whether to convert hidden slides to the converted PDF document. More...
 
def GetOutput_type ()
 Get output type used to specify which component (slides, handouts, notes pages, or an outline) of PowerPoint document is to be converted to PDF document. More...
 
def Set (intent, frame_output_slides, output_type, handout_order, output_hidden_slides, include_doc_props, disable_vba_code)
 Set value. More...
 
def SetDisable_vba_code (value)
 Set a boolean value decide whether to disable the execution of vba code in the PowerPoint document. More...
 
def SetFrame_output_slides (value)
 Set a boolean value which indicates whether to frame output slides in the converted PDF document. More...
 
def SetHandout_order (value)
 Set handout order used to specify the page layout order in which slides appear on converted handouts. More...
 
def SetInclude_doc_props (value)
 Set a boolean value which indicates whether to include PowerPoint document properties in the converted PDF document. More...
 
def SetIntent (value)
 Set converting intent. More...
 
def SetOutput_hidden_slides (value)
 Set a boolean value which indicates whether to convert hidden slides to the converted PDF document. More...
 
def SetOutput_type (value)
 Set output type used to specify which component (slides, handouts, notes pages, or an outline) of PowerPoint document is to be converted to PDF document. More...
 

Detailed Description

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

Member Function Documentation

◆ GetDisable_vba_code()

fsdk.PowerPoint2PDFSettingData.GetDisable_vba_code ( )

Get a boolean value decide whether to disable the execution of vba code in the PowerPoint 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 PowerPoint document.

◆ GetFrame_output_slides()

fsdk.PowerPoint2PDFSettingData.GetFrame_output_slides ( )

Get a boolean value which indicates whether to frame output slides in the converted PDF document.

true means to frame output slides in the converted PDF document.
false means not to frame output slides in the converted PDF document.

Returns
A boolean value which indicates whether to frame output slides in the converted PDF document.

◆ GetHandout_order()

fsdk.PowerPoint2PDFSettingData.GetHandout_order ( )

Get handout order used to specify the page layout order in which slides appear on converted handouts.

Note
This would be available only when output_type is one of following value:
Returns
Handout order used to specify the page layout order in which slides appear on converted handouts. Handouts can be used to show multiple slides on one page when converting PowerPoint to PDF. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_HandoutOrderHorizontalFirst and this should be one of these values.

◆ GetInclude_doc_props()

fsdk.PowerPoint2PDFSettingData.GetInclude_doc_props ( )

Get a boolean value which indicates whether to include PowerPoint document properties in the converted PDF document.

true means to include PowerPoint document properties in the converted PDF document.
false means not to include PowerPoint document properties in the converted PDF document.

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

◆ GetIntent()

fsdk.PowerPoint2PDFSettingData.GetIntent ( )

Get converting intent.

Returns
Converting intent. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_ConvertIntentPrint and this should be one of these values.

◆ GetOutput_hidden_slides()

fsdk.PowerPoint2PDFSettingData.GetOutput_hidden_slides ( )

Get a boolean value which indicates whether to convert hidden slides to the converted PDF document.

true means to convert hidden slides to the converted PDF document.
false means not to convert hidden slides to the converted PDF document.

Returns
A boolean value which indicates whether to convert hidden slides to the converted PDF document.

◆ GetOutput_type()

fsdk.PowerPoint2PDFSettingData.GetOutput_type ( )

Get output type used to specify which component (slides, handouts, notes pages, or an outline) of PowerPoint document is to be converted to PDF document.

Returns
Output type used to specify which component (slides, handouts, notes pages, or an outline) of PowerPoint document is to be converted to PDF document. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_OutputSlides and this should be one of these values.

◆ Set()

def fsdk.PowerPoint2PDFSettingData.Set (   intent,
  frame_output_slides,
  output_type,
  handout_order,
  output_hidden_slides,
  include_doc_props,
  disable_vba_code 
)

Set value.

Parameters
[in]intentConverting intent. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_ConvertIntentPrint and this should be one of these values.
[in]frame_output_slidesA boolean value which indicates whether to frame output slides in the converted PDF document or not.
[in]output_typeOutput type used to specify which component of PowerPoint document is to be converted. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_OutputSlides and this should be one of these values.
[in]handout_orderHandout order used to specify the page layout order in which slides appear on converted handouts that show multiple slides on one page. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_HandoutOrderHorizontalFirst and this should be one of these values.
[in]output_hidden_slidesA boolean value which indicates whether to convert hidden slides to the converted PDF document.
[in]include_doc_propsA boolean value which indicates whether to include PowerPoint document properties in the converted PDF document.
[in]disable_vba_codeA boolean value decide whether to disable the execution of vba code in the PowerPoint document.
Returns
None.

◆ SetDisable_vba_code()

fsdk.PowerPoint2PDFSettingData.SetDisable_vba_code (   value)

Set a boolean value decide whether to disable the execution of vba code in the PowerPoint 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 PowerPoint document.
Returns
None.

◆ SetFrame_output_slides()

fsdk.PowerPoint2PDFSettingData.SetFrame_output_slides (   value)

Set a boolean value which indicates whether to frame output slides in the converted PDF document.

true means to frame output slides in the converted PDF document.
false means not to frame output slides in the converted PDF document.

Parameters
[in]valueA boolean value which indicates whether to frame output slides in the converted PDF document.
Returns
None.

◆ SetHandout_order()

fsdk.PowerPoint2PDFSettingData.SetHandout_order (   value)

Set handout order used to specify the page layout order in which slides appear on converted handouts.

Note
This would be available only when output_type is one of following value:
Parameters
[in]valueHandout order used to specify the page layout order in which slides appear on converted handouts. Handouts can be used to show multiple slides on one page when converting PowerPoint to PDF. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_HandoutOrderHorizontalFirst and this should be one of these values.
Returns
None.

◆ SetInclude_doc_props()

fsdk.PowerPoint2PDFSettingData.SetInclude_doc_props (   value)

Set a boolean value which indicates whether to include PowerPoint document properties in the converted PDF document.

true means to include PowerPoint document properties in the converted PDF document.
false means not to include PowerPoint document properties in the converted PDF document.

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

◆ SetIntent()

fsdk.PowerPoint2PDFSettingData.SetIntent (   value)

Set converting intent.

Parameters
[in]valueConverting intent. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_ConvertIntentPrint and this should be one of these values.
Returns
None.

◆ SetOutput_hidden_slides()

fsdk.PowerPoint2PDFSettingData.SetOutput_hidden_slides (   value)

Set a boolean value which indicates whether to convert hidden slides to the converted PDF document.

true means to convert hidden slides to the converted PDF document.
false means not to convert hidden slides to the converted PDF document.

Parameters
[in]valueA boolean value which indicates whether to convert hidden slides to the converted PDF document.
Returns
None.

◆ SetOutput_type()

fsdk.PowerPoint2PDFSettingData.SetOutput_type (   value)

Set output type used to specify which component (slides, handouts, notes pages, or an outline) of PowerPoint document is to be converted to PDF document.

Parameters
[in]valueOutput type used to specify which component (slides, handouts, notes pages, or an outline) of PowerPoint document is to be converted to PDF document. Please refer to values starting from fsdk.PowerPoint2PDFSettingDataE_OutputSlides and this should be one of these values.
Returns
None.