Foxit PDF Conversion SDK
fpdfconversionsdk.PDF2ExcelSettingData Class Reference

Public Member Functions

def GetDecimal_symbol ()
 Get a string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents. More...
 
def GetThousands_separator ()
 Get a string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents. More...
 
def GetWorkbook_settings ()
 Get an enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents. More...
 
def Set (decimal_symbol, thousands_separator, workbook_settings)
 Set value. More...
 
def SetDecimal_symbol (value)
 Set a string value which indicates being recognized as decimal during the conversion of PDF documents to excel format documents. More...
 
def SetThousands_separator (value)
 Set a string value which indicates being recognized as thousands separator during the conversion of PDF documents to excel format documents. More...
 
def SetWorkbook_settings (value)
 Set an enumeration value which indicates the setting of the workbook for the conversion of PDF documents to Excel format documents. More...
 

Detailed Description

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

Member Function Documentation

◆ GetDecimal_symbol()

fpdfconversionsdk.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()

fpdfconversionsdk.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()

fpdfconversionsdk.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 fpdfconversionsdk.PDF2ExcelSettingDataE_WorkbookSettingsDocument and this should be one of these values. Default value: fpdfconversionsdk.PDF2ExcelSettingDataE_WorkbookSettingsEachPage .

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

◆ Set()

def fpdfconversionsdk.PDF2ExcelSettingData.Set (   decimal_symbol,
  thousands_separator,
  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()

fpdfconversionsdk.PDF2ExcelSettingData.SetDecimal_symbol (   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()

fpdfconversionsdk.PDF2ExcelSettingData.SetThousands_separator (   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()

fpdfconversionsdk.PDF2ExcelSettingData.SetWorkbook_settings (   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 fpdfconversionsdk.PDF2ExcelSettingDataE_WorkbookSettingsDocument and this should be one of these values. Default value: fpdfconversionsdk.PDF2ExcelSettingDataE_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.