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

Inherits Object.

Public Types

enum  ConvertQuality { e_ConvertQualityStandard = 0, e_ConvertQualityMinimum = 1 }
 Enumeration for quality for converting Excel to PDF. More...
 
enum  ScaleType { e_ScaleTypeNone = 0, e_ScaleTypeFitAllColumns = 1, e_ScaleTypeFitAllRows = 2, e_ScaleTypeFitSheet = 3 }
 Enumeration for scaling type for each sheet in the Excel document for convertin Excel to PDF. More...
 

Public Member Functions

 Excel2PDFSettingData ()
 Constructor.
 
 Excel2PDFSettingData (bool include_doc_props, bool convert_to_pdfa, ConvertQuality quality, bool ignore_print_area, ScaleType scale_type)
 Constructor, with parameters. More...
 
Excel2PDFSettingDataoperator= (const Excel2PDFSettingData &data)
 Assign operator. More...
 
void Set (bool include_doc_props, bool convert_to_pdfa, ConvertQuality quality, bool ignore_print_area, ScaleType scale_type)
 Constructor, with parameters. More...
 

Public Attributes

bool 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. More...
 
bool ignore_print_area
 A boolean value which indicates whether to ignore any print area set when convering Excel document to PDF file. More...
 
bool include_doc_props
 A boolean value which indicates whether to include Excel document properties in the converted PDF document. More...
 
ConvertQuality quality
 Quality for covnerting Excel to PDF. Please refer to values starting from Excel2PDFSettingData::e_ConvertQualityStandard and this should be one of these values.
 
ScaleType scale_type
 Scale type for the Excel sheet when converting Excel document to PDF file. Please refer to values starting from Excel2PDFSettingData::e_ScaleTypeNone and this should be one of these values.
 

Detailed Description

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

Member Enumeration Documentation

◆ ConvertQuality

Enumeration for quality for converting Excel to PDF.

Values of this enumeration should be used alone.

Enumerator
e_ConvertQualityStandard 

Standard quality.

e_ConvertQualityMinimum 

Minimum quality.

◆ ScaleType

Enumeration for scaling type for each sheet in the Excel document for convertin Excel to PDF.

Values of this enumeration should be used alone.

Enumerator
e_ScaleTypeNone 

No scaling.

e_ScaleTypeFitAllColumns 

Fit all columns of one sheet on one page.

e_ScaleTypeFitAllRows 

Fit all rows of one sheet on one page.

e_ScaleTypeFitSheet 

Fit a sheet on one page.

Constructor & Destructor Documentation

◆ Excel2PDFSettingData()

foxit::addon::conversion::Excel2PDFSettingData::Excel2PDFSettingData ( bool  include_doc_props,
bool  convert_to_pdfa,
ConvertQuality  quality,
bool  ignore_print_area,
ScaleType  scale_type 
)
inline

Constructor, with parameters.

Parameters
[in]include_doc_propsA boolean value which indicates whether to include Excel document properties in the converted PDF document.
[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]qualityQuality for covnerting Excel to PDF. Please refer to values starting from Excel2PDFSettingData::e_ConvertQualityStandard and this should be one of these values.
[in]ignore_print_areaA boolean value which indicates whether to ignore any print area set when convering Excel document to PDF file.
[in]scale_typeScale type for the Excel sheet when converting Excel document to PDF file. Please refer to values starting from Excel2PDFSettingData::e_ScaleTypeNone and this should be one of these values.

Member Function Documentation

◆ operator=()

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

Assign operator.

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

◆ Set()

void foxit::addon::conversion::Excel2PDFSettingData::Set ( bool  include_doc_props,
bool  convert_to_pdfa,
ConvertQuality  quality,
bool  ignore_print_area,
ScaleType  scale_type 
)
inline

Constructor, with parameters.

Parameters
[in]include_doc_propsA boolean value which indicates whether to include Excel document properties in the converted PDF document.
[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]qualityQuality for covnerting Excel to PDF. Please refer to values starting from Excel2PDFSettingData::e_ConvertQualityStandard and this should be one of these values.
[in]ignore_print_areaA boolean value which indicates whether to ignore any print area set when convering Excel document to PDF file.
[in]scale_typeScale type for the Excel sheet when converting Excel document to PDF file. Please refer to values starting from Excel2PDFSettingData::e_ScaleTypeNone and this should be one of these values.
Returns
None.

Member Data Documentation

◆ convert_to_pdfa

bool foxit::addon::conversion::Excel2PDFSettingData::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.

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

◆ ignore_print_area

bool foxit::addon::conversion::Excel2PDFSettingData::ignore_print_area

A boolean value which indicates whether to ignore any print area set when convering Excel document to PDF file.

true means to ignore any setting of print area in Excel document.
false means to use the setting of print areas in Excel document.

◆ include_doc_props

bool foxit::addon::conversion::Excel2PDFSettingData::include_doc_props

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

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