Foxit PDF SDK
fsdk.PDF2OfficeSettingData类 参考

Public 成员函数

def GetEnable_matching_system_fonts ()
 Get 一个布尔值,用于指示在将 PDF 文档转换为 Office 格式文档时,是否精确匹配系统字体。默认值为false更多...
 
def GetEnable_ml_recognition ()
 Get 一个布尔值,指示是否启用基于机器学习的识别功能。默认值:false更多...
 
def GetEnable_trailing_space ()
 Get 一个布尔值,指示是否在PDF文档到Office格式文档的转换中 为段落中的行添加尾随空格。默认值:true更多...
 
def GetExcel_setting_data ()
 Get 用于将PDF文档转换为Excel格式文档的设置数据对象。 更多...
 
def GetInclude_images ()
 Get 一个布尔值,指示是否在PDF文档到Office格式文档的转换中 包含PDF文档中的图像。默认值:true更多...
 
def GetInclude_pdf_comments ()
 Get 一个布尔值,指示是否在PDF文档到Office格式文档的转换中 包含PDF文档注释。默认值:true更多...
 
def GetMetrics_data_folder_path ()
 Get 包含度量数据文件的文件夹的有效路径。这不应该是空字符串。 更多...
 
def GetPage_range ()
 Get 一个范围对象,指定某些页面。这些页面将用于将PDF文档转换为Office格式文档。 更多...
 
def GetPower_point_setting_data ()
 Get 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。 更多...
 
def GetTimeout ()
 Get pDF转换超时时间(毫秒)。 更多...
 
def GetWord_setting_data ()
 Get 用于将PDF文档转换为Word格式文档的设置数据对象。 更多...
 
def 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)
 设置值。 更多...
 
def SetEnable_matching_system_fonts (value)
 Set 一个布尔值,用于指示在将 PDF 文档转换为 Office 格式文档时,是否精确匹配系统字体。默认值为false更多...
 
def SetEnable_ml_recognition (value)
 Set 一个布尔值,指示是否启用基于机器学习的识别功能。默认值:false更多...
 
def SetEnable_trailing_space (value)
 Set 一个布尔值,指示是否在PDF文档到Office格式文档的转换中 为段落中的行添加尾随空格。默认值:true更多...
 
def SetExcel_setting_data (value)
 Set 用于将PDF文档转换为Excel格式文档的设置数据对象。 更多...
 
def SetInclude_images (value)
 Set 一个布尔值,指示是否在PDF文档到Office格式文档的转换中 包含PDF文档中的图像。默认值:true更多...
 
def SetInclude_pdf_comments (value)
 Set 一个布尔值,指示是否在PDF文档到Office格式文档的转换中 包含PDF文档注释。默认值:true更多...
 
def SetMetrics_data_folder_path (value)
 Set 包含度量数据文件的文件夹的有效路径。这不应该是空字符串。 更多...
 
def SetPage_range (value)
 Set 一个范围对象,指定某些页面。这些页面将用于将PDF文档转换为Office格式文档。 更多...
 
def SetPower_point_setting_data (value)
 Set 用于将PDF文档转换为PowerPoint格式文档的设置数据对象。 更多...
 
def SetTimeout (value)
 Set pDF转换超时时间(毫秒)。 更多...
 
def SetWord_setting_data (value)
 Set 用于将PDF文档转换为Word格式文档的设置数据对象。 更多...
 

详细描述

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

成员函数说明

◆ GetEnable_matching_system_fonts()

fsdk.PDF2OfficeSettingData.GetEnable_matching_system_fonts ( )

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

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

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

◆ GetEnable_ml_recognition()

fsdk.PDF2OfficeSettingData.GetEnable_ml_recognition ( )

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

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

注解
我们用于识别无边框表格的基于机器学习的技术使用HTTPS,需要网络连接在转换过程中将渲染PDF页面的图像发送到我们的服务器。
返回
一个布尔值,指示是否启用基于机器学习的识别功能。默认值:false

◆ GetEnable_trailing_space()

fsdk.PDF2OfficeSettingData.GetEnable_trailing_space ( )

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

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

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

◆ GetExcel_setting_data()

fsdk.PDF2OfficeSettingData.GetExcel_setting_data ( )

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

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

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

◆ GetInclude_images()

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

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

fsdk.PDF2OfficeSettingData.GetMetrics_data_folder_path ( )

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

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

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

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

◆ GetPage_range()

fsdk.PDF2OfficeSettingData.GetPage_range ( )

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

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

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

◆ GetPower_point_setting_data()

fsdk.PDF2OfficeSettingData.GetPower_point_setting_data ( )

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

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

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

◆ GetTimeout()

fsdk.PDF2OfficeSettingData.GetTimeout ( )

Get pDF转换超时时间(毫秒)。

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

注解
资源释放可能需要一些时间,因此整个转换过程花费的时间 可能超过此参数设置的时间。
返回
PDF转换超时时间(毫秒)。

◆ GetWord_setting_data()

fsdk.PDF2OfficeSettingData.GetWord_setting_data ( )

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

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

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

◆ Set()

def 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转换SDK包的"res/metrics_data"文件夹中提供。
[in]enable_ml_recognition一个布尔值,指示是否启用基于机器学习的识别功能。默认值:falsetrue意味着启用基于机器学习的识别功能来识别PDF文档中的无边框表格。 为了更好地转换表格,它将在识别的无边框表格上绘制宽度为1的黑色边框。 这将在后续版本中得到改进。 当识别功能在服务器端执行并完成时,将返回相关结果。 false意味着禁用基于机器学习的识别功能。 将启用非基于机器学习的识别功能。
[in]page_range一个范围对象,指定一些页面。这些页面将用于将PDF文档转换为Office格式文档。
[in]include_pdf_comments一个布尔值,指示是否在PDF文档到Office格式文档的转换中包含PDF文档注释。默认值:truetrue意味着在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格式文档的转换中为段落中的行添加尾随空格。默认值:truetrue意味着在PDF文档到Office格式文档的转换中为段落中的行添加尾随空格。 false意味着不为段落中的行添加尾随空格,并为段落添加允许换行的属性。 目前,此支持仅限于80以上文本 涉及一行结尾和下一行开头都是韩文的段落。这仅适用于 将PDF文档转换为Word格式文档,对其他Office格式的支持计划在未来实现。
[in]include_images一个布尔值,指示是否在PDF文档到Office格式文档的转换中包含PDF文档中的图像。默认值:truetrue意味着在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页面的图像发送到我们的服务器。
返回
无。

◆ SetEnable_matching_system_fonts()

fsdk.PDF2OfficeSettingData.SetEnable_matching_system_fonts (   value)

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

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

参数
[in]value一个布尔值,用于指示在将 PDF 文档转换为 Office 格式文档时,是否精确匹配系统字体。默认值为false
返回
None.

◆ SetEnable_ml_recognition()

fsdk.PDF2OfficeSettingData.SetEnable_ml_recognition (   value)

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

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

注解
我们用于识别无边框表格的基于机器学习的技术使用HTTPS,需要网络连接在转换过程中将渲染PDF页面的图像发送到我们的服务器。
参数
[in]value一个布尔值,指示是否启用基于机器学习的识别功能。默认值:false
返回
None.

◆ SetEnable_trailing_space()

fsdk.PDF2OfficeSettingData.SetEnable_trailing_space (   value)

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

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

参数
[in]value一个布尔值,指示是否在PDF文档到Office格式文档的转换中 为段落中的行添加尾随空格。默认值:true
返回
None.

◆ SetExcel_setting_data()

fsdk.PDF2OfficeSettingData.SetExcel_setting_data (   value)

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

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

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

◆ SetInclude_images()

fsdk.PDF2OfficeSettingData.SetInclude_images (   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()

fsdk.PDF2OfficeSettingData.SetInclude_pdf_comments (   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()

fsdk.PDF2OfficeSettingData.SetMetrics_data_folder_path (   value)

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

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

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

参数
[in]value包含度量数据文件的文件夹的有效路径。这不应该是空字符串。
返回
None.

◆ SetPage_range()

fsdk.PDF2OfficeSettingData.SetPage_range (   value)

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

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

参数
[in]value一个范围对象,指定某些页面。这些页面将用于将PDF文档转换为Office格式文档。
返回
None.

◆ SetPower_point_setting_data()

fsdk.PDF2OfficeSettingData.SetPower_point_setting_data (   value)

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

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

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

◆ SetTimeout()

fsdk.PDF2OfficeSettingData.SetTimeout (   value)

Set pDF转换超时时间(毫秒)。

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

注解
资源释放可能需要一些时间,因此整个转换过程花费的时间 可能超过此参数设置的时间。
参数
[in]valuePDF转换超时时间(毫秒)。
返回
None.

◆ SetWord_setting_data()

fsdk.PDF2OfficeSettingData.SetWord_setting_data (   value)

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

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

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