Foxit PDF SDK
foxit::addon::conversion::PowerPoint2PDFSettingData Class Reference

Inherits Object.

Public Types

enum  ConvertIntent { e_ConvertIntentPrint = 0, e_ConvertIntentScreen = 1 }
 Enumeration for intent for converting PowerPoint to PDF. More...
 
enum  HandoutOrder { e_HandoutOrderHorizontalFirst = 0, e_HandoutOrderVerticalFirst = 1 }
 Enumeration for specifying 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. More...
 
enum  OutputType {
  e_OutputSlides = 1, e_OutputNotesPages = 2, e_OutputOutline = 3, e_OutputOneSlideHandouts = 4,
  e_OutputTwoSlideHandouts = 5, e_OutputThreeSlideHandouts = 6, e_OutputFourSlideHandouts = 7, e_OutputSixSlideHandouts = 8,
  e_OutputNineSlideHandouts = 9
}
 Enumeration for output type for converting PowerPoint to PDF. More...
 

Public Member Functions

 PowerPoint2PDFSettingData ()
 Constructor.
 
 PowerPoint2PDFSettingData (ConvertIntent intent, bool frame_output_slides, OutputType output_type, HandoutOrder handout_order, bool output_hidden_slides, bool include_doc_props)
 Constructor, with parameters. More...
 
PowerPoint2PDFSettingDataoperator= (const PowerPoint2PDFSettingData &data)
 Assign operator. More...
 
void Set (ConvertIntent intent, bool frame_output_slides, OutputType output_type, HandoutOrder handout_order, bool output_hidden_slides, bool include_doc_props)
 Set value. More...
 

Public Attributes

bool frame_output_slides
 A boolean value which indicates whether to frame output slides in the converted PDF document. More...
 
HandoutOrder handout_order
 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 PowerPoint2PDFSettingData::e_HandoutOrderHorizontalFirst and this should be one of these values. More...
 
bool include_doc_props
 A boolean value which indicates whether to include PowerPoint document properties in the converted PDF document. More...
 
ConvertIntent intent
 Converting intent. Please refer to values starting from PowerPoint2PDFSettingData::e_ConvertIntentPrint and this should be one of these values.
 
bool output_hidden_slides
 A boolean value which indicates whether to convert hidden slides to the converted PDF document. More...
 
OutputType output_type
 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 PowerPoint2PDFSettingData::e_OutputSlides and this should be one of these values.
 

Detailed Description

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

Member Enumeration Documentation

◆ ConvertIntent

Enumeration for intent for converting PowerPoint to PDF.

Values of this enumeration should be used alone.

Enumerator
e_ConvertIntentPrint 

Intent: converted result file will be used for printing.

e_ConvertIntentScreen 

Intent: converted result file will be used for showing on screen.

◆ HandoutOrder

Enumeration for specifying 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.

Values of this enumeration should be used alone.

Enumerator
e_HandoutOrderHorizontalFirst 

When converting PowerPoint in handouts type, convert handouts with consecutive slides displayed horizontally first (in horizontal rows).

e_HandoutOrderVerticalFirst 

When converting PowerPoint in handouts type, convert handouts with consecutive slides displayed vertically first (in vertical columns).

◆ OutputType

Enumeration for output type for converting PowerPoint to PDF.

Values of this enumeration should be used alone.

Enumerator
e_OutputSlides 

Output type: slides.

e_OutputNotesPages 

Output type: notes pages.

e_OutputOutline 

Output type: outline view.

e_OutputOneSlideHandouts 

Output type: handouts with one slide per handout page.

e_OutputTwoSlideHandouts 

Output type: handouts with two slide per handout page.

e_OutputThreeSlideHandouts 

Output type: handouts with three slide per handout page.

e_OutputFourSlideHandouts 

Output type: handouts with four slide per handout page.

e_OutputSixSlideHandouts 

Output type: handouts with six slide per handout page.

e_OutputNineSlideHandouts 

Output type: handouts with nine slide per handout page.

Constructor & Destructor Documentation

◆ PowerPoint2PDFSettingData()

foxit::addon::conversion::PowerPoint2PDFSettingData::PowerPoint2PDFSettingData ( ConvertIntent  intent,
bool  frame_output_slides,
OutputType  output_type,
HandoutOrder  handout_order,
bool  output_hidden_slides,
bool  include_doc_props 
)
inline

Constructor, with parameters.

Parameters
[in]intentConverting intent. Please refer to values starting from PowerPoint2PDFSettingData::e_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 PowerPoint2PDFSettingData::e_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 PowerPoint2PDFSettingData::e_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.

Member Function Documentation

◆ operator=()

PowerPoint2PDFSettingData& foxit::addon::conversion::PowerPoint2PDFSettingData::operator= ( const PowerPoint2PDFSettingData data)
inline

Assign operator.

Parameters
[in]dataAnother PowerPoint-to-PDF setting data object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ Set()

void foxit::addon::conversion::PowerPoint2PDFSettingData::Set ( ConvertIntent  intent,
bool  frame_output_slides,
OutputType  output_type,
HandoutOrder  handout_order,
bool  output_hidden_slides,
bool  include_doc_props 
)
inline

Set value.

Parameters
[in]intentConverting intent. Please refer to values starting from PowerPoint2PDFSettingData::e_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 PowerPoint2PDFSettingData::e_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 PowerPoint2PDFSettingData::e_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.
Returns
None.

Member Data Documentation

◆ frame_output_slides

bool foxit::addon::conversion::PowerPoint2PDFSettingData::frame_output_slides

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.

◆ handout_order

HandoutOrder foxit::addon::conversion::PowerPoint2PDFSettingData::handout_order

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 PowerPoint2PDFSettingData::e_HandoutOrderHorizontalFirst and this should be one of these values.

Note
This would be available only when output_type is one of following value:

◆ include_doc_props

bool foxit::addon::conversion::PowerPoint2PDFSettingData::include_doc_props

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.

◆ output_hidden_slides

bool foxit::addon::conversion::PowerPoint2PDFSettingData::output_hidden_slides

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.