Foxit PDF SDK
com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData Class Reference

Public Member Functions

 PDF2ExcelSettingData ()
 Constructor.
 
 PDF2ExcelSettingData (String decimal_symbol, String thousands_separator, int workbook_settings)
 Constructor, with parameters. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
String getDecimal_symbol ()
 Get a string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents. More...
 
String getThousands_separator ()
 Get a string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents. More...
 
int getWorkbook_settings ()
 Get an enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents. More...
 
void set (String decimal_symbol, String thousands_separator, int workbook_settings)
 Set value. More...
 
void setDecimal_symbol (String value)
 Set a string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents. More...
 
void setThousands_separator (String value)
 Set a string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents. More...
 
void setWorkbook_settings (int value)
 Set an enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents. More...
 

Static Public Attributes

static final int e_WorkbookSettingsDocument = 0
 Create single worksheet for the document.
 
static final int e_WorkbookSettingsEachPage = 2
 Create worksheet for each page.
 
static final int e_WorkbookSettingsEachTable = 1
 Create worksheet for each table.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PDF2ExcelSettingData()

com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.PDF2ExcelSettingData ( String  decimal_symbol,
String  thousands_separator,
int  workbook_settings 
)

Constructor, with parameters.

Parameters
[in]decimal_symbolA string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents.
[in]thousands_separatorA string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents.
[in]workbook_settingsAn enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ getDecimal_symbol()

com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.getDecimal_symbol ( )

Get a string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents.

The decimal symbol is used to separate the integer part and the decimal part of a number. If this parameter is set to ".", then the number "123.456" will be recognized as 123.456. If this parameter is set to ",", then the number "123,456" will be recognized as 123.456. If this parameter is not set, the decimal symbol will be recognized automatically.

Note
Currently, this parameter is only useful for cells with only numbers and separators. The value of this parameter must be different from the value of parameter thousands_separator. To ensure the correct recognition of the decimal symbol, this parameter should be set together with parameter thousands_separator.
Returns
A string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents.

◆ getThousands_separator()

com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.getThousands_separator ( )

Get a string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents.

The thousands separator is used to separate the thousands part of a number. If this parameter is set to ",", then the number "123,456" will be recognized as 123456. If this parameter is set to ".", then the number "123.456" will be recognized as 123456. If this parameter is set to " ", then the number "123 456" will be recognized as 123456. If this parameter is not set, the thousands separator will be recognized automatically.

Note
Currently, this parameter is only useful for cells with only numbers and separators. The value of this parameter must be different from the value of parameter decimal_symbol. To ensure the correct recognition of the thousands separator, this parameter should be set together with parameter decimal_symbol.
Returns
A string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents.

◆ getWorkbook_settings()

com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.getWorkbook_settings ( )

Get an enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents.

Please refer to values starting from com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.e_WorkbookSettingsDocument and this should be one of these values. Default value: com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.e_WorkbookSettingsEachPage .

Returns
An enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents.

◆ set()

void com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.set ( String  decimal_symbol,
String  thousands_separator,
int  workbook_settings 
)

Set value.

Parameters
[in]decimal_symbolA string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents.
[in]thousands_separatorA string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents.
[in]workbook_settingsAn enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents.
Returns
None.

◆ setDecimal_symbol()

com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.setDecimal_symbol ( String  value)

Set a string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents.

The decimal symbol is used to separate the integer part and the decimal part of a number. If this parameter is set to ".", then the number "123.456" will be recognized as 123.456. If this parameter is set to ",", then the number "123,456" will be recognized as 123.456. If this parameter is not set, the decimal symbol will be recognized automatically.

Note
Currently, this parameter is only useful for cells with only numbers and separators. The value of this parameter must be different from the value of parameter thousands_separator. To ensure the correct recognition of the decimal symbol, this parameter should be set together with parameter thousands_separator.
Parameters
[in]valueA string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents.
Returns
None.

◆ setThousands_separator()

com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.setThousands_separator ( String  value)

Set a string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents.

The thousands separator is used to separate the thousands part of a number. If this parameter is set to ",", then the number "123,456" will be recognized as 123456. If this parameter is set to ".", then the number "123.456" will be recognized as 123456. If this parameter is set to " ", then the number "123 456" will be recognized as 123456. If this parameter is not set, the thousands separator will be recognized automatically.

Note
Currently, this parameter is only useful for cells with only numbers and separators. The value of this parameter must be different from the value of parameter decimal_symbol. To ensure the correct recognition of the thousands separator, this parameter should be set together with parameter decimal_symbol.
Parameters
[in]valueA string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents.
Returns
None.

◆ setWorkbook_settings()

com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.setWorkbook_settings ( int  value)

Set an enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents.

Please refer to values starting from com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.e_WorkbookSettingsDocument and this should be one of these values. Default value: com.foxit.sdk.addon.conversion.pdf2office.PDF2ExcelSettingData.e_WorkbookSettingsEachPage .

Parameters
[in]valueAn enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents.
Returns
None.