FSDK::Preflight类 参考

Public 成员函数
	Analyze (preflight_setting_data, progress_callback)
	分析 PDF 文件。 更多...
	AnalyzeAndFixup (preflight_setting_data, progress_callback)
	分析并修复 PDF 文件。 更多...
	CanFixup (item_key)
	检查项目密钥是否可以被修复。 更多...
	constructor ()
	构造函数。
	GenerateReport (preflight_report_setting_data, progress_callback)
	在分析或修复后生成报告。 更多...
	GenerateXMLReport (xml_report_file_path, progress_callback)
	在分析或修复后生成XML报告。 更多...
	GetGroupItemComment (key)
	通过密钥获取组项的注释。 更多...
	GetGroupItemName (key)
	通过密钥获取组项的名称。 更多...
	GetGroupNamesArray (library_type, operate_type)
	获取与库类型和操作类型对应的所有组名称数组。 更多...
	GetItemKeysArray (group_name)
	获取具有特定组名称的项目密钥数组。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...
	SetPreflightGroupLocalCallback (callback)
	为预检组项设置本地化名称和注释回调。 更多...

详细描述

此类表示与指定行业配置文件、检查或修复匹配的分析和修复功能。

成员函数说明

Analyze()

FSDK::Preflight::Analyze (   preflight_setting_data,   progress_callback  )

inline

分析 PDF 文件。

参数

[in]	preflight_setting_data	预检设置数据。
[in]	progress_callback	由用户实现的 FSDK.ProgressCallback 对象，可用于获取进度数据。

返回

一个 FSDK.ResultInformation 对象。

AnalyzeAndFixup()

FSDK::Preflight::AnalyzeAndFixup (   preflight_setting_data,   progress_callback  )

inline

分析并修复 PDF 文件。

参数

[in]	preflight_setting_data	预检设置数据。
[in]	progress_callback	由用户实现的 FSDK.ProgressCallback 对象，可用于获取进度数据。

返回

一个 FSDK.ResultInformation 对象。

CanFixup()

FSDK::Preflight::CanFixup (   item_key )

inline

检查项目密钥是否可以被修复。

参数

[in]

item_key

项目密钥。可以通过 FSDK.Preflight.GetItemKeysArray 获取。

返回

true 表示可以被修复，而 false 表示不能被修复。

GenerateReport()

FSDK::Preflight::GenerateReport (   preflight_report_setting_data,   progress_callback  )

inline

在分析或修复后生成报告。

此方法应在 FSDK.Preflight.Analyze 或 FSDK.Preflight.AnalyzeAndFixup 之后调用。

参数

[in]	preflight_report_setting_data	预检报告设置数据。
[in]	progress_callback	由用户实现的 FSDK.ProgressCallback 对象，可用于获取进度数据。

返回

true 表示成功，而 false 表示失败。

GenerateXMLReport()

FSDK::Preflight::GenerateXMLReport (   xml_report_file_path,   progress_callback  )

inline

在分析或修复后生成XML报告。

此方法应在 FSDK.Preflight.Analyze 或 FSDK.Preflight.AnalyzeAndFixup 之后调用。

参数

[in]	xml_report_file_path	用于保存XML报告文件的完整路径。这不应该是空字符串。
[in]	progress_callback	由用户实现的 FSDK.ProgressCallback 对象，可用于获取进度数据。 可以为 NULL。默认值：NULL。

返回

true 表示成功，而 false 表示失败。

GetGroupItemComment()

FSDK::Preflight::GetGroupItemComment (   key )

inline

通过密钥获取组项的注释。

仅提供英文，其他语言需要参考翻译的XML自行获取。

参数

[in]

key

组项的密钥。

返回

通过 FSDK.Preflight.GetGroupNamesArray 和 FSDK.Preflight.GetItemKeysArray 接口获取的组项的注释。

GetGroupItemName()

FSDK::Preflight::GetGroupItemName (   key )

inline

通过密钥获取组项的名称。

仅提供英文，其他语言需要参考翻译的XML自行获取。

参数

[in]

key

组项的密钥。

返回

通过 FSDK.Preflight.GetGroupNamesArray 和 FSDK.Preflight.GetItemKeysArray 接口获取的组项的名称。

GetGroupNamesArray()

FSDK::Preflight::GetGroupNamesArray (   library_type,   operate_type  )

inline

获取与库类型和操作类型对应的所有组名称数组。

参数

[in]

library_type

库类型。

请参考从 FSDK.PreflightSettingData.e_LibraryTypeFoxit 开始的值， 并且应该是这些值之一。

参数

[in]

operate_type

操作类型。 请参考从 FSDK.PreflightSettingData.e_OperateTypeProfiles 开始的值， 并且应该是这些值之一。

返回

组名称数组。

GetItemKeysArray()

FSDK::Preflight::GetItemKeysArray (   group_name )

inline

获取具有特定组名称的项目密钥数组。

参数

[in]

group_name

可从 FSDK.Preflight.GetGroupNamesArray 接口获取的组名称。

返回

项目密钥数组。

IsEmpty()

FSDK::Preflight::IsEmpty ( )

inline

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回

true 表示当前对象为空，而 false 表示不为空。

SetPreflightGroupLocalCallback()

FSDK::Preflight::SetPreflightGroupLocalCallback (   callback )

inline

为预检组项设置本地化名称和注释回调。

此回调由 FSDK.Preflight.GetGroupItemName 和 FSDK.Preflight.GetGroupItemComment 使用，以提供组项的本地化名称和注释。当回调中有给定密钥的本地化字符串时， 将使用它；否则将使用默认的库字符串。

参数

[in]

callback

提供 FSDK.PreflightGroupLocalCallback 本地化名称和注释的回调对象。

返回

无。