Foxit PDF Conversion SDK

Public 成员函数 | 所有成员列表
com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData类 参考

## Public 成员函数
| PDF2OfficeSettingData ()
| 构造函数。
| PDF2OfficeSettingData (String metrics_data_folder_path, boolean enable_ml_recognition, Range page_range, boolean include_pdf_comments, PDF2WordSettingData word_setting_data, PDF2PowerPointSettingData power_point_setting_data, PDF2ExcelSettingData excel_setting_data, boolean enable_trailing_space, boolean include_images, boolean enable_matching_system_fonts)
| 带参数的构造函数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
boolean | getEnable_matching_system_fonts ()
| Get 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否准确匹配系统字体。默认值：false。 更多...
boolean | getEnable_ml_recognition ()
| Get 一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。 更多...
boolean | getEnable_trailing_space ()
| Get 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否从段落中的行添加尾随空格。默认值：true。 更多...
PDF2ExcelSettingData | getExcel_setting_data ()
| Get 用于将PDF文档转换为Excel格式文档的设置数据对象。 更多...
boolean | getInclude_images ()
| Get 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档中的图像。默认值：true。 更多...
boolean | getInclude_pdf_comments ()
| Get 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档注释。默认值：true。 更多...
String | getMetrics_data_folder_path ()
| Get 包含度量数据文件的文件夹的有效路径。此参数不应为空字符串。 更多...
Range | getPage_range ()
| Get 指定某些页面的范围对象。这些页面将用于将PDF文档转换为Office格式文档。 更多...
PDF2PowerPointSettingData | getPower_point_setting_data ()
| Get 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。 更多...
PDF2WordSettingData | getWord_setting_data ()
| Get 用于将PDF文档转换为Word格式文档的设置数据对象。 更多...
void | set (String metrics_data_folder_path, boolean enable_ml_recognition, Range page_range, boolean include_pdf_comments, PDF2WordSettingData word_setting_data, PDF2PowerPointSettingData power_point_setting_data, PDF2ExcelSettingData excel_setting_data, boolean enable_trailing_space, boolean include_images, boolean enable_matching_system_fonts)
| 设置值。 更多...
void | setEnable_matching_system_fonts (boolean value)
| Set 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否准确匹配系统字体。默认值：false。 更多...
void | setEnable_ml_recognition (boolean value)
| Set 一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。 更多...
void | setEnable_trailing_space (boolean value)
| Set 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否从段落中的行添加尾随空格。默认值：true。 更多...
void | setExcel_setting_data (PDF2ExcelSettingData value)
| Set 用于将PDF文档转换为Excel格式文档的设置数据对象。 更多...
void | setInclude_images (boolean value)
| Set 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档中的图像。默认值：true。 更多...
void | setInclude_pdf_comments (boolean value)
| Set 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档注释。默认值：true。 更多...
void | setMetrics_data_folder_path (String value)
| Set 包含度量数据文件的文件夹的有效路径。此参数不应为空字符串。 更多...
void | setPage_range (Range value)
| Set 指定某些页面的范围对象。这些页面将用于将PDF文档转换为Office格式文档。 更多...
void | setPower_point_setting_data (PDF2PowerPointSettingData value)
| Set 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。 更多...
void | setWord_setting_data (PDF2WordSettingData value)
| Set 用于将PDF文档转换为Word格式文档的设置数据对象。 更多...

## 详细描述

此类表示用于将PDF转换为Office(Word、Excel或PowerPoint)格式文件的设置数据。

## 构造及析构函数说明

## ◆ PDF2OfficeSettingData()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.PDF2OfficeSettingData | ( | String | metrics_data_folder_path,
|  | boolean | enable_ml_recognition,
|  | Range | page_range,
|  | boolean | include_pdf_comments,
|  | PDF2WordSettingData | word_setting_data,
|  | PDF2PowerPointSettingData | power_point_setting_data,
|  | PDF2ExcelSettingData | excel_setting_data,
|  | boolean | enable_trailing_space,
|  | boolean | include_images,
|  | boolean | enable_matching_system_fonts
| ) |  |

带参数的构造函数。

参数

  [in] | metrics_data_folder_path | (已弃用)包含度量数据文件的文件夹的有效路径。此参数不应为空字符串。 这些度量数据文件用于在转换过程中模拟Office格式文档排版过程。 它们在Foxit PDF Conversion SDK包的"res/metrics_data"文件夹中提供。
  [in] | enable_ml_recognition | 一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。 true表示启用基于机器学习的识别功能以识别PDF文档中的无边框表格。 为了更好地转换表格，它将在识别出的无边框表格上绘制宽度为1的黑色边框。 这将在后续版本中得到改进。 此识别功能将在服务器端执行，并在完成后返回相关结果。 false表示禁用基于机器学习的识别功能。 将启用不基于机器学习的识别功能。
  [in] | page_range | 指定某些页面的范围对象。这些页面将用于将PDF文档转换为Office格式文档。默认值：true。
  [in] | include_pdf_comments | 一个布尔值，指示在将PDF文档转换为Office格式文档时是否包含PDF文档注释。默认值：true。 true表示在将PDF文档转换为Office格式文档时包含PDF文档注释。 false表示在将PDF文档转换为Office格式文档时不包含PDF文档注释。
  [in] | word_setting_data | 用于将PDF文档转换为Word格式文档的设置数据对象。
  [in] | power_point_setting_data | 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。
  [in] | excel_setting_data | 用于将PDF文档转换为Excel格式文档的设置数据对象。
  [in] | enable_trailing_space | 一个布尔值，指示在将PDF文档转换为Office格式文档时是否从段落中的行添加尾随空格。默认值：true。 true表示在将PDF文档转换为Office格式文档时从段落中的行添加尾随空格。 false表示不从段落中的行添加尾随空格，并向段落添加允许换行的属性。 目前，此支持仅限于超过80的文本涉及一行的结尾和下一行的开头都是韩语的段落。这仅适用于 将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。
  [in] | include_images | 一个布尔值，指示在将PDF文档转换为Office格式文档时是否包含PDF文档中的图像。默认值：true。 true表示在将PDF文档转换为Office格式文档时包含PDF文档中的图像。 false表示在将PDF文档转换为Office格式文档时不包含PDF文档中的图像。 这仅适用于将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。
  [in] | enable_matching_system_fonts | 一个布尔值，指示在将PDF文档转换为Office格式文档时是否启用匹配系统字体。默认值：false。 这仅适用于将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。

注解
  我们用于识别无边框表格的基于机器学习的技术使用HTTPS，并需要网络连接在转换过程中将渲染的PDF页面图像发送到我们的服务器。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ getEnable_matching_system_fonts()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getEnable_matching_system_fonts | ( |  | ) |

Get 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否准确匹配系统字体。默认值：false。

true表示在将PDF文档转换为Office格式文档时准确匹配系统字体。 false表示在将PDF文档转换为Office格式文档时不准确匹配系统字体。 这仅适用于将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。

返回
  一个布尔值，指示在将PDF文档转换为Office格式文档时 是否准确匹配系统字体。默认值：false。

## ◆ getEnable_ml_recognition()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getEnable_ml_recognition | ( |  | ) |

Get 一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。

true表示启用基于机器学习的识别功能以识别PDF文档中的无边框表格。 此识别功能将在服务器端执行，并在完成后返回相关结果。 为了更好地转换表格，它将在识别出的无边框表格上绘制宽度为1的黑色边框。 这将在后续版本中得到改进。 false表示禁用基于机器学习的识别功能。 将启用不基于机器学习的识别功能。

注解
  我们用于识别无边框表格的基于机器学习的技术使用HTTPS，并需要网络连接在转换过程中将渲染的PDF页面图像发送到我们的服务器。

返回
  一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。

## ◆ getEnable_trailing_space()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getEnable_trailing_space | ( |  | ) |

Get 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否从段落中的行添加尾随空格。默认值：true。

true表示在将PDF文档转换为Office格式文档时从段落中的行添加尾随空格。 false表示不从段落中的行添加尾随空格，并向段落添加允许换行的属性。 目前，此支持仅限于超过80的文本涉及一行的结尾和下一行的开头都是韩语的段落。这仅适用于 将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。

返回
  一个布尔值，指示在将PDF文档转换为Office格式文档时 是否从段落中的行添加尾随空格。默认值：true。

## ◆ getExcel_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getExcel_setting_data | ( |  | ) |

Get 用于将PDF文档转换为Excel格式文档的设置数据对象。

此设置仅对PDF文档到Excel格式文档的转换有效。 有关更多详细信息，请参阅类 PDF2ExcelSettingData 。

返回
  用于将PDF文档转换为Excel格式文档的设置数据对象。

## ◆ getInclude_images()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getInclude_images | ( |  | ) |

Get 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档中的图像。默认值：true。

true表示在将PDF文档转换为Office格式文档时包含PDF文档中的图像。 false表示在将PDF文档转换为Office格式文档时不包含PDF文档中的图像。 这仅适用于将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。

返回
  一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档中的图像。默认值：true。

## ◆ getInclude_pdf_comments()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getInclude_pdf_comments | ( |  | ) |

Get 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档注释。默认值：true。

true表示在将PDF文档转换为Office格式文档时包含PDF文档注释。 false表示在将PDF文档转换为Office格式文档时不包含PDF文档注释。

返回
  一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档注释。默认值：true。

## ◆ getMetrics_data_folder_path()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getMetrics_data_folder_path | ( |  | ) |

Get 包含度量数据文件的文件夹的有效路径。此参数不应为空字符串。

弃用:
  自Foxit PDF Conversion SDK 2.1起已弃用此属性。度量数据将包含在动态库中。

这些度量数据文件用于在转换过程中模拟Office格式文档排版过程。 它们在Foxit PDF Conversion SDK包的"res/metrics_data"文件夹中提供。

返回
  包含度量数据文件的文件夹的有效路径。此参数不应为空字符串。

## ◆ getPage_range()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getPage_range | ( |  | ) |

Get 指定某些页面的范围对象。这些页面将用于将PDF文档转换为Office格式文档。

有效页面范围：从0到(count - 1)，其中count是PDF文档的总页数。 如果此范围对象由默认构造函数构造且未设置任何值，则表示 当前文档的所有页面都将用于将PDF文档转换为Office格式文档。

返回
  指定某些页面的范围对象。这些页面将用于将PDF文档转换为Office格式文档。

## ◆ getPower_point_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getPower_point_setting_data | ( |  | ) |

Get 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。

此设置仅对PDF文档到PowerPoint格式文档的转换有效。 有关更多详细信息，请参阅类 PDF2PowerPointSettingData 。

返回
  用于将PDF文档转换为PowerPoint格式文档的设置数据对象。

## ◆ getWord_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getWord_setting_data | ( |  | ) |

Get 用于将PDF文档转换为Word格式文档的设置数据对象。

此设置仅对PDF文档到Word格式文档的转换有效。 有关更多详细信息，请参阅类 PDF2WordSettingData 。

返回
  用于将PDF文档转换为Word格式文档的设置数据对象。

## ◆ set()

void com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.set | ( | String | metrics_data_folder_path,
|  | boolean | enable_ml_recognition,
|  | Range | page_range,
|  | boolean | include_pdf_comments,
|  | PDF2WordSettingData | word_setting_data,
|  | PDF2PowerPointSettingData | power_point_setting_data,
|  | PDF2ExcelSettingData | excel_setting_data,
|  | boolean | enable_trailing_space,
|  | boolean | include_images,
|  | boolean | enable_matching_system_fonts
| ) |  |

设置值。

参数

  [in] | metrics_data_folder_path | (已弃用)包含度量数据文件的文件夹的有效路径。此参数不应为空字符串。 这些度量数据文件用于在转换过程中模拟Office格式文档排版过程。 它们在Foxit PDF Conversion SDK包的"res/metrics_data"文件夹中提供。
  [in] | enable_ml_recognition | 一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。 true表示启用基于机器学习的识别功能以识别PDF文档中的无边框表格。 为了更好地转换表格，它将在识别出的无边框表格上绘制宽度为1的黑色边框。 这将在后续版本中得到改进。 此识别功能将在服务器端执行，并在完成后返回相关结果。 false表示禁用基于机器学习的识别功能。 将启用不基于机器学习的识别功能。
  [in] | page_range | 指定某些页面的范围对象。这些页面将用于将PDF文档转换为Office格式文档。
  [in] | include_pdf_comments | 一个布尔值，指示在将PDF文档转换为Office格式文档时是否包含PDF文档注释。默认值：true。 true表示在将PDF文档转换为Office格式文档时包含PDF文档注释。 false表示在将PDF文档转换为Office格式文档时不包含PDF文档注释。
  [in] | word_setting_data | 用于将PDF文档转换为Word格式文档的设置数据对象。
  [in] | power_point_setting_data | 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。
  [in] | excel_setting_data | 用于将PDF文档转换为Excel格式文档的设置数据对象。
  [in] | enable_trailing_space | 一个布尔值，指示在将PDF文档转换为Office格式文档时是否从段落中的行添加尾随空格。默认值：true。 true表示在将PDF文档转换为Office格式文档时从段落中的行添加尾随空格。 false表示不从段落中的行添加尾随空格，并向段落添加允许换行的属性。 目前，此支持仅限于超过80的文本涉及一行的结尾和下一行的开头都是韩语的段落。这仅适用于 将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。
  [in] | include_images | 一个布尔值，指示在将PDF文档转换为Office格式文档时是否包含PDF文档中的图像。默认值：true。 true表示在将PDF文档转换为Office格式文档时包含PDF文档中的图像。 false表示在将PDF文档转换为Office格式文档时不包含PDF文档中的图像。 这仅适用于将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。
  [in] | enable_matching_system_fonts | 一个布尔值，指示在将PDF文档转换为Office格式文档时是否启用匹配系统字体。默认值：false。 这仅适用于将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。

注解
  我们用于识别无边框表格的基于机器学习的技术使用HTTPS，并需要网络连接在转换过程中将渲染的PDF页面图像发送到我们的服务器。

返回
  无。

## ◆ setEnable_matching_system_fonts()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setEnable_matching_system_fonts | ( | boolean | value | ) |

Set 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否准确匹配系统字体。默认值：false。

true表示在将PDF文档转换为Office格式文档时准确匹配系统字体。 false表示在将PDF文档转换为Office格式文档时不准确匹配系统字体。 这仅适用于将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。

参数

  [in] | value | 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否准确匹配系统字体。默认值：false。

返回
  None.

## ◆ setEnable_ml_recognition()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setEnable_ml_recognition | ( | boolean | value | ) |

Set 一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。

true表示启用基于机器学习的识别功能以识别PDF文档中的无边框表格。 此识别功能将在服务器端执行，并在完成后返回相关结果。 为了更好地转换表格，它将在识别出的无边框表格上绘制宽度为1的黑色边框。 这将在后续版本中得到改进。 false表示禁用基于机器学习的识别功能。 将启用不基于机器学习的识别功能。

注解
  我们用于识别无边框表格的基于机器学习的技术使用HTTPS，并需要网络连接在转换过程中将渲染的PDF页面图像发送到我们的服务器。

参数

  [in] | value | 一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。

返回
  None.

## ◆ setEnable_trailing_space()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setEnable_trailing_space | ( | boolean | value | ) |

Set 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否从段落中的行添加尾随空格。默认值：true。

true表示在将PDF文档转换为Office格式文档时从段落中的行添加尾随空格。 false表示不从段落中的行添加尾随空格，并向段落添加允许换行的属性。 目前，此支持仅限于超过80的文本涉及一行的结尾和下一行的开头都是韩语的段落。这仅适用于 将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。

参数

  [in] | value | 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否从段落中的行添加尾随空格。默认值：true。

返回
  None.

## ◆ setExcel_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setExcel_setting_data | ( | PDF2ExcelSettingData | value | ) |

Set 用于将PDF文档转换为Excel格式文档的设置数据对象。

此设置仅对PDF文档到Excel格式文档的转换有效。 有关更多详细信息，请参阅类 PDF2ExcelSettingData 。

参数

  [in] | value | 用于将PDF文档转换为Excel格式文档的设置数据对象。

返回
  None.

## ◆ setInclude_images()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setInclude_images | ( | boolean | value | ) |

Set 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档中的图像。默认值：true。

true表示在将PDF文档转换为Office格式文档时包含PDF文档中的图像。 false表示在将PDF文档转换为Office格式文档时不包含PDF文档中的图像。 这仅适用于将PDF文档转换为Word格式文档，计划在未来支持其他Office格式。

参数

  [in] | value | 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档中的图像。默认值：true。

返回
  None.

## ◆ setInclude_pdf_comments()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setInclude_pdf_comments | ( | boolean | value | ) |

Set 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档注释。默认值：true。

true表示在将PDF文档转换为Office格式文档时包含PDF文档注释。 false表示在将PDF文档转换为Office格式文档时不包含PDF文档注释。

参数

  [in] | value | 一个布尔值，指示在将PDF文档转换为Office格式文档时 是否包含PDF文档注释。默认值：true。

返回
  None.

## ◆ setMetrics_data_folder_path()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setMetrics_data_folder_path | ( | String | value | ) |

Set 包含度量数据文件的文件夹的有效路径。此参数不应为空字符串。

弃用:
  自Foxit PDF Conversion SDK 2.1起已弃用此属性。度量数据将包含在动态库中。

这些度量数据文件用于在转换过程中模拟Office格式文档排版过程。 它们在Foxit PDF Conversion SDK包的"res/metrics_data"文件夹中提供。

参数

  [in] | value | 包含度量数据文件的文件夹的有效路径。此参数不应为空字符串。

返回
  None.

## ◆ setPage_range()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setPage_range | ( | Range | value | ) |

Set 指定某些页面的范围对象。这些页面将用于将PDF文档转换为Office格式文档。

有效页面范围：从0到(count - 1)，其中count是PDF文档的总页数。 如果此范围对象由默认构造函数构造且未设置任何值，则表示 当前文档的所有页面都将用于将PDF文档转换为Office格式文档。

参数

  [in] | value | 指定某些页面的范围对象。这些页面将用于将PDF文档转换为Office格式文档。

返回
  None.

## ◆ setPower_point_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setPower_point_setting_data | ( | PDF2PowerPointSettingData | value | ) |

Set 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。

此设置仅对PDF文档到PowerPoint格式文档的转换有效。 有关更多详细信息，请参阅类 PDF2PowerPointSettingData 。

参数

  [in] | value | 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。

返回
  None.

## ◆ setWord_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setWord_setting_data | ( | PDF2WordSettingData | value | ) |

Set 用于将PDF文档转换为Word格式文档的设置数据对象。

此设置仅对PDF文档到Word格式文档的转换有效。 有关更多详细信息，请参阅类 PDF2WordSettingData 。

参数

  [in] | value | 用于将PDF文档转换为Word格式文档的设置数据对象。

返回
  None.