Foxit PDF SDK
|
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 converting Excel to PDF. More... | |
Public Member Functions | |
Excel2PDFSettingData () | |
Constructor. | |
Excel2PDFSettingData (bool include_doc_props, ConvertQuality quality, bool ignore_print_area, ScaleType scale_type, bool convert_to_pdfa) | |
Constructor, with parameters. More... | |
Excel2PDFSettingData & | operator= (const Excel2PDFSettingData &data) |
Assign operator. More... | |
void | Set (bool include_doc_props, ConvertQuality quality, bool ignore_print_area, ScaleType scale_type, bool convert_to_pdfa) |
Set value. 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 converting 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. | |
This class represents setting data used for converting Excel to PDF.
Enumeration for scaling type for each sheet in the Excel document for converting Excel 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 Excel document properties in the converted PDF document. |
[in] | quality | Quality 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_area | A boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file. |
[in] | 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. |
[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 |
Assign operator.
[in] | data | Another Excel-to-PDF setting data object, whose value would be assigned to current object. |
|
inline |
Set value.
[in] | include_doc_props | A boolean value which indicates whether to include Excel document properties in the converted PDF document. |
[in] | quality | Quality 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_area | A boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file. |
[in] | 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. |
[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. |
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.
bool foxit::addon::conversion::Excel2PDFSettingData::ignore_print_area |
A boolean value which indicates whether to ignore any print area set when converting 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.
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.