Foxit PDF Conversion SDK
foxit.conversion.office2pdf.Excel2PDFSettingData Class Reference

Inherits SystemIDisposable.

Public Member Functions

 Excel2PDFSettingData ()
 Constructor.
 
 Excel2PDFSettingData (bool is_separate_workbook, bool is_output_hidden_worksheets, WStringArray worksheet_names)
 Constructor, with parameters. More...
 
void Set (bool is_separate_workbook, bool is_output_hidden_worksheets, WStringArray worksheet_names)
 Set value. More...
 

Properties

bool is_output_hidden_worksheets [get, set]
 A boolean value which indicates whether to output the hidden worksheets. More...
 
bool is_separate_workbook [get, set]
 A boolean value which indicates whether to export worksheets to separate PDF files. More...
 
WStringArrayworksheet_names [get, set]
 An array of specific worksheet names to be converted to PDF files. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Excel2PDFSettingData()

foxit.conversion.office2pdf.Excel2PDFSettingData.Excel2PDFSettingData ( bool  is_separate_workbook,
bool  is_output_hidden_worksheets,
WStringArray  worksheet_names 
)
inline

Constructor, with parameters.

Parameters
[in]is_separate_workbookA boolean value which indicates whether to export worksheets to separate PDF files.
[in]is_output_hidden_worksheetsA boolean value which indicates whether to output the hidden worksheets.
[in]worksheet_namesAn array of specific worksheet names to be converted to PDF files.

Member Function Documentation

◆ Set()

void foxit.conversion.office2pdf.Excel2PDFSettingData.Set ( bool  is_separate_workbook,
bool  is_output_hidden_worksheets,
WStringArray  worksheet_names 
)
inline

Set value.

Parameters
[in]is_separate_workbookA boolean value which indicates whether to export worksheets to separate PDF files.
[in]is_output_hidden_worksheetsA boolean value which indicates whether to output the hidden worksheets.
[in]worksheet_namesAn array of specific worksheet names to be converted to PDF files.
Returns
None.

Property Documentation

◆ is_output_hidden_worksheets

bool foxit.conversion.office2pdf.Excel2PDFSettingData.is_output_hidden_worksheets
getset

A boolean value which indicates whether to output the hidden worksheets.

true means to output the hidden worksheets, while false means not.

◆ is_separate_workbook

bool foxit.conversion.office2pdf.Excel2PDFSettingData.is_separate_workbook
getset

A boolean value which indicates whether to export worksheets to separate PDF files.

true means to export each worksheet to separate PDF files, while false means not.

◆ worksheet_names

WStringArray foxit.conversion.office2pdf.Excel2PDFSettingData.worksheet_names
getset

An array of specific worksheet names to be converted to PDF files.

If this array is empty, all worksheets will be converted to PDF files.