Foxit PDF SDK

Public 成员函数 | 属性 | 所有成员列表
foxit.addon.conversion.pdf2office.PDF2OfficeSettingData类 参考

继承自 SystemIDisposable .

## Public 成员函数
| PDF2OfficeSettingData ()
| 构造函数。
| PDF2OfficeSettingData (string metrics_data_folder_path, bool enable_ml_recognition, Range page_range, bool include_pdf_comments, PDF2WordSettingData word_setting_data, PDF2PowerPointSettingData power_point_setting_data, PDF2ExcelSettingData excel_setting_data, bool enable_trailing_space, bool include_images, int timeout, bool enable_matching_system_fonts)
| 带参数的构造函数。 更多...
void | Set (string metrics_data_folder_path, bool enable_ml_recognition, Range page_range, bool include_pdf_comments, PDF2WordSettingData word_setting_data, PDF2PowerPointSettingData power_point_setting_data, PDF2ExcelSettingData excel_setting_data, bool enable_trailing_space, bool include_images, int timeout, bool enable_matching_system_fonts)
| 设置值。 更多...

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

## 详细描述

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

## 构造及析构函数说明

## ◆ PDF2OfficeSettingData()

foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.PDF2OfficeSettingData | ( | string | metrics_data_folder_path,
|  | bool | enable_ml_recognition,
|  | Range | page_range,
|  | bool | include_pdf_comments,
|  | PDF2WordSettingData | word_setting_data,
|  | PDF2PowerPointSettingData | power_point_setting_data,
|  | PDF2ExcelSettingData | excel_setting_data,
|  | bool | enable_trailing_space,
|  | bool | include_images,
|  | int | timeout,
|  | bool | enable_matching_system_fonts
| ) |  |
| inline

带参数的构造函数。

参数

  [in] | metrics_data_folder_path | （已弃用）包含度量数据文件的文件夹的有效路径。这不应该是空字符串。 这些度量数据文件用于在转换过程中模拟Office格式文档排版过程。 它们在Foxit PDF转换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页面的图像发送到我们的服务器。

## 成员函数说明

## ◆ Set()

void foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.Set | ( | string | metrics_data_folder_path,
|  | bool | enable_ml_recognition,
|  | Range | page_range,
|  | bool | include_pdf_comments,
|  | PDF2WordSettingData | word_setting_data,
|  | PDF2PowerPointSettingData | power_point_setting_data,
|  | PDF2ExcelSettingData | excel_setting_data,
|  | bool | enable_trailing_space,
|  | bool | include_images,
|  | int | timeout,
|  | bool | enable_matching_system_fonts
| ) |  |
| inline

设置值。

参数

  [in] | metrics_data_folder_path | (已弃用)包含度量数据文件的文件夹的有效路径。这不应该是空字符串。 这些度量数据文件用于在转换过程中模拟Office格式文档的排版过程。 它们在Foxit PDF转换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

bool foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.enable_matching_system_fonts
| get set

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

true 表示在将 PDF 文档转换为 Office 格式文档时，精确匹配系统字体。 false 表示在将 PDF 文档转换为 Office 格式文档时，不精确匹配系统字体。 该选项目前仅适用于将 PDF 文档转换为 Word 格式，对其他 Office 格式的支持将在后续版本中提供。

## ◆ enable_ml_recognition

bool foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.enable_ml_recognition
| get set

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

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

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

## ◆ enable_trailing_space

bool foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.enable_trailing_space
| get set

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

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

## ◆ excel_setting_data

PDF2ExcelSettingData foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.excel_setting_data
| get set

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

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

## ◆ include_images

bool foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.include_images
| get set

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

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

## ◆ include_pdf_comments

bool foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.include_pdf_comments
| get set

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

true表示在PDF文档到Office格式文档的转换中包含PDF文档注释。 false表示在PDF文档到Office格式文档的转换中不包含PDF文档注释。

## ◆ metrics_data_folder_path

string foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.metrics_data_folder_path
| get set

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

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

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

## ◆ page_range

Range foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.page_range
| get set

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

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

## ◆ power_point_setting_data

PDF2PowerPointSettingData foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.power_point_setting_data
| get set

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

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

## ◆ timeout

int foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.timeout
| get set

PDF转换超时时间（毫秒）。

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

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

## ◆ word_setting_data

PDF2WordSettingData foxit.addon.conversion.pdf2office.PDF2OfficeSettingData.word_setting_data
| get set

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

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