Foxit PDF SDK

Public 成员函数 | Public 属性 | 所有成员列表
FSDK::PDF2OfficeSettingData类 参考

## Public 成员函数
| constructor ()
| 构造函数。
| constructor (metrics_data_folder_path, enable_ml_recognition, page_range, include_pdf_comments, word_setting_data, power_point_setting_data, excel_setting_data, enable_trailing_space, include_images, timeout, enable_matching_system_fonts)
| 带参数的构造函数。 更多...
| Set (metrics_data_folder_path, enable_ml_recognition, page_range, include_pdf_comments, word_setting_data, power_point_setting_data, excel_setting_data, enable_trailing_space, include_images, timeout, enable_matching_system_fonts)
| 设置值。 更多...

## Public 属性
| enable_matching_system_fonts
| 一个布尔值，指示在将 PDF 文档转换为 Office 格式文档时是否精确匹配系统字体。默认值：false。 更多...
| enable_ml_recognition
| 一个布尔值，指示是否启用基于机器学习的识别功能。默认值：false。 更多...
| enable_trailing_space
| 一个布尔值，指示在将 PDF 文档转换为 Office 格式文档时是否在段落行中添加尾随空格。默认值：true。 更多...
| excel_setting_data
| 用于将 PDF 文档转换为 Excel 格式文档的设置数据对象。 更多...
| include_images
| 一个布尔值，指示在将 PDF 文档转换为 Office 格式文档时是否包含 PDF 文档中的图像。默认值：true。 更多...
| include_pdf_comments
| 一个布尔值，指示是否在将 PDF 文档转换为 Office 格式文档时包含 PDF 文档注释。默认值：true。 更多...
| metrics_data_folder_path
| 包含指标数据文件的文件夹的有效路径。这不应该是空字符串。 更多...
| page_range
| 指定某些页面的范围对象。这些页面将用于将 PDF 文档转换为 Office 格式文档。 更多...
| power_point_setting_data
| 用于将 PDF 文档转换为 PowerPoint 格式文档的设置数据对象。 更多...
| timeout
| 用于 PDF 转换的超时时间（毫秒）。 更多...
| word_setting_data
| 用于将 PDF 文档转换为 Word 格式文档的设置数据对象。 更多...

## 详细描述

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

## 成员函数说明

## ◆ constructor()

FSDK::PDF2OfficeSettingData::constructor | ( | metrics_data_folder_path | ,
|  | enable_ml_recognition | ,
|  | page_range | ,
|  | include_pdf_comments | ,
|  | word_setting_data | ,
|  | power_point_setting_data | ,
|  | excel_setting_data | ,
|  | enable_trailing_space | ,
|  | include_images | ,
|  | timeout | ,
|  | 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] | timeout | 用于 PDF 转换的超时毫秒数。默认值：0。
  [in] | enable_matching_system_fonts | 一个布尔值，指示在将 PDF 文档转换为 Office 格式文档时是否启用匹配系统字体。默认值：false。 这仅适用于将 PDF 文档转换为 Word 格式文档，计划在未来支持其他 Office 格式。

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

## ◆ Set()

FSDK::PDF2OfficeSettingData::Set | ( | metrics_data_folder_path | ,
|  | enable_ml_recognition | ,
|  | page_range | ,
|  | include_pdf_comments | ,
|  | word_setting_data | ,
|  | power_point_setting_data | ,
|  | excel_setting_data | ,
|  | enable_trailing_space | ,
|  | include_images | ,
|  | timeout | ,
|  | 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] | timeout | 用于 PDF 转换的超时毫秒数。默认值：0。
  [in] | enable_matching_system_fonts | 一个布尔值，指示在将 PDF 文档转换为 Office 格式文档时是否启用匹配系统字体。默认值：false。 这仅适用于将 PDF 文档转换为 Word 格式文档，计划在未来支持其他 Office 格式。

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

返回
  无。

## 类成员变量说明

## ◆ enable_matching_system_fonts

FSDK::PDF2OfficeSettingData::enable_matching_system_fonts

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

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

## ◆ enable_ml_recognition

FSDK::PDF2OfficeSettingData::enable_ml_recognition

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

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

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

## ◆ enable_trailing_space

FSDK::PDF2OfficeSettingData::enable_trailing_space

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

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

## ◆ excel_setting_data

FSDK::PDF2OfficeSettingData::excel_setting_data

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

此设置仅对将 PDF 文档转换为 Excel 格式文档有效。 更多详情请参考类 FSDK.PDF2ExcelSettingData。

## ◆ include_images

FSDK::PDF2OfficeSettingData::include_images

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

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

## ◆ include_pdf_comments

FSDK::PDF2OfficeSettingData::include_pdf_comments

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

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

## ◆ metrics_data_folder_path

FSDK::PDF2OfficeSettingData::metrics_data_folder_path

包含指标数据文件的文件夹的有效路径。这不应该是空字符串。

弃用:
  自 Foxit PDF SDK 10.1 起，当前属性已被弃用。指标数据将包含在动态库中。

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

## ◆ page_range

FSDK::PDF2OfficeSettingData::page_range

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

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

## ◆ power_point_setting_data

FSDK::PDF2OfficeSettingData::power_point_setting_data

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

此设置仅对将 PDF 文档转换为 PowerPoint 格式文档有效。 更多详情请参考类 FSDK.PDF2PowerPointSettingData。

## ◆ timeout

FSDK::PDF2OfficeSettingData::timeout

用于 PDF 转换的超时时间（毫秒）。

如果转换过程未在指定时间内完成，转换过程将被终止。 此值应为非负值。如果值为 0，则表示 PDF 转换不进行超时处理。
此参数仅在通过函数 FSDK.PDF2Office.Initialize 设置 Foxit PDF 转换引擎时有用。 默认值：0。

注解
  资源释放可能需要一些时间，因此整个转换过程所花费的时间 可能会超过此参数设置的时间。

## ◆ word_setting_data

FSDK::PDF2OfficeSettingData::word_setting_data

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

此设置仅对将 PDF 文档转换为 Word 格式文档有效。 更多详情请参考类 FSDK.PDF2WordSettingData。