Foxit PDF SDK
foxit::addon::compliance::PDFACompliance类 参考
类 foxit::addon::compliance::PDFACompliance 继承关系图:
foxit::Base

Public 类型

enum  Version {
  e_VersionPDFA1a = 1, e_VersionPDFA1b = 2, e_VersionPDFA2a = 3, e_VersionPDFA2b = 4,
  e_VersionPDFA2u = 5, e_VersionPDFA3a = 6, e_VersionPDFA3b = 7, e_VersionPDFA3u = 8,
  e_VersionPDFA1bWithoutFBC = 9, e_VersionPDFA2bWithoutFBC = 10, e_VersionPDFA3bWithoutFBC = 11
}
 PDF/A版本的枚举。 更多...
 

Public 成员函数

 PDFACompliance ()
 构造函数。
 
 PDFACompliance (const PDFACompliance &other)
 带另一个PDF/A合规性对象的构造函数。 更多...
 
 ~PDFACompliance ()
 析构函数。
 
ResultInformation ConvertPDFFile (const wchar_t *src_pdf_path, const wchar_t *saved_pdf_path, Version convert_to_version, ProgressCallback *progress_callback=0)
 使用指定的PDF/A版本转换PDF文件。 更多...
 
ResultInformation ConvertPDFFile (const wchar_t *src_pdf_path, const wchar_t *saved_pdf_path, Version convert_to_version, ComplianceEngine::ViewOrPrintCondition view_or_print_condition, bool convert_problem_pages_into_image, bool convert_all_pages_into_image, int32 image_resolution, ProgressCallback *progress_callback=0)
 使用指定的PDF/A版本转换PDF文件。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator != (const PDFACompliance &other) const
 不相等操作符。 更多...
 
PDFAComplianceoperator= (const PDFACompliance &other)
 赋值操作符。 更多...
 
bool operator== (const PDFACompliance &other) const
 相等操作符。 更多...
 
ResultInformation Verify (Version verify_version, const wchar_t *src_pdf_path, int first_page_index=0, int last_page_index=-1, ProgressCallback *progress_callback=0)
 使用指定的PDF/A版本验证PDF文件。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类可用于PDF/A合规性验证或将PDF文件转换为PDF/A格式。 请确保ComplianceEngine已成功初始化。

参见
ComplianceEngine

成员枚举类型说明

◆ Version

PDF/A版本的枚举。

此枚举的值应该单独使用。

枚举值
e_VersionPDFA1a 

PDF/A-1a。

e_VersionPDFA1b 

PDF/A-1b。

e_VersionPDFA2a 

PDF/A-2a。

e_VersionPDFA2b 

PDF/A-2b。

e_VersionPDFA2u 

PDF/A-2u。

e_VersionPDFA3a 

PDF/A-3a。

e_VersionPDFA3b 

PDF/A-3b。

e_VersionPDFA3u 

PDF/A-3u。

e_VersionPDFA1bWithoutFBC 

PDF/A-1b(无后备转换),仅用于转换。

e_VersionPDFA2bWithoutFBC 

PDF/A-2b(无后备转换),仅用于转换。

e_VersionPDFA3bWithoutFBC 

PDF/A-3b(无后备转换),仅用于转换。

构造及析构函数说明

◆ PDFACompliance()

foxit::addon::compliance::PDFACompliance::PDFACompliance ( const PDFACompliance other)

带另一个PDF/A合规性对象的构造函数。

参数
[in]other另一个PDF/A合规性对象。

成员函数说明

◆ ConvertPDFFile() [1/2]

ResultInformation foxit::addon::compliance::PDFACompliance::ConvertPDFFile ( const wchar_t *  src_pdf_path,
const wchar_t *  saved_pdf_path,
Version  convert_to_version,
ProgressCallback progress_callback = 0 
)

使用指定的PDF/A版本转换PDF文件。

参数
[in]src_pdf_path要转换的源PDF文件的完整路径。这不应该是空字符串。
[in]saved_pdf_path保存转换后PDF文件的完整路径。这不应该是空字符串。
[in]convert_to_version要转换的PDF/A版本。请参考从PDFACompliance::e_VersionPDFA1a 开始的值,这应该是这些值之一。
[in]progress_callback由用户实现的进度回调,可用于获取进度数据。 这可以是NULL。默认值:NULL
返回
ResultInformation对象。

◆ ConvertPDFFile() [2/2]

ResultInformation foxit::addon::compliance::PDFACompliance::ConvertPDFFile ( const wchar_t *  src_pdf_path,
const wchar_t *  saved_pdf_path,
Version  convert_to_version,
ComplianceEngine::ViewOrPrintCondition  view_or_print_condition,
bool  convert_problem_pages_into_image,
bool  convert_all_pages_into_image,
int32  image_resolution,
ProgressCallback progress_callback = 0 
)

使用指定的PDF/A版本转换PDF文件。

参数
[in]src_pdf_path要转换的源PDF文件的完整路径。这不应该是空字符串。
[in]saved_pdf_path保存转换后PDF文件的完整路径。这不应该是空字符串。
[in]convert_to_version要转换的PDF/A版本。请参考从PDFACompliance::e_VersionPDFA1a开始的值, 这应该是这些值之一。
[in]view_or_print_condition查看或打印条件。请参考从ComplianceEngine::e_ViewOrPrintConditionAuto开始的值, 这应该是这些值之一。
[in]to_convert_problem_pages_into_image转换失败时是否将有问题的页面转换为图像。 true表示转换,false表示不转换。 仅当convert_to_version不是PDFACompliance::e_VersionPDFA1aPDFACompliance::e_VersionPDFA2aPDFACompliance::e_VersionPDFA3a时才有效。
[in]to_convert_all_pages_into_image转换失败时是否将所有页面转换为图像。true表示转换,false表示不转换。 仅当convert_to_version不是PDFACompliance::e_VersionPDFA1aPDFACompliance::e_VersionPDFA2aPDFACompliance::e_VersionPDFA3a时才有效。
[in]image_resolution转换图像的分辨率(PPI)。有效范围:60-1200。 仅当convert_to_version不是PDFACompliance::e_VersionPDFA1aPDFACompliance::e_VersionPDFA2aPDFACompliance::e_VersionPDFA3a时才有效。
[in]progress_callback由用户实现的进度回调,可用于获取进度数据。 这可以是NULL。默认值:NULL
返回
ResultInformation对象。

◆ IsEmpty()

bool foxit::addon::compliance::PDFACompliance::IsEmpty ( ) const

检查当前对象是否为空。

当前对象为空时,意味着当前对象无用。

返回
true表示当前对象为空,false表示不为空。

◆ operator !=()

bool foxit::addon::compliance::PDFACompliance::operator != ( const PDFACompliance other) const

不相等操作符。

参数
[in]other另一个PDF/A合规性对象。此函数将检查当前对象是否不等于此对象。
返回
true表示不相等,false表示相等。

◆ operator=()

PDFACompliance& foxit::addon::compliance::PDFACompliance::operator= ( const PDFACompliance other)

赋值操作符。

参数
[in]other另一个PDF/A合规性对象,其值将被赋给当前对象。
返回
当前对象自身的引用。

◆ operator==()

bool foxit::addon::compliance::PDFACompliance::operator== ( const PDFACompliance other) const

相等操作符。

参数
[in]other另一个PDF/A合规性对象。此函数将检查当前对象是否等于此对象。
返回
true表示相等,false表示不相等。

◆ Verify()

ResultInformation foxit::addon::compliance::PDFACompliance::Verify ( Version  verify_version,
const wchar_t *  src_pdf_path,
int  first_page_index = 0,
int  last_page_index = -1,
ProgressCallback progress_callback = 0 
)

使用指定的PDF/A版本验证PDF文件。

参数
[in]verify_version要验证的PDF/A版本。 请参考从PDFACompliance::e_VersionPDFA1a开始的值, 这应该是这些值之一。
[in]src_pdf_path要验证的源PDF文件的完整路径。这不应该是空字符串。
[in]first_page_index要验证的第一页的索引,从0开始。默认值:0。
[in]last_page_index要验证的最后一页的索引。如果这是-1,那意味着 源PDF文件的所有页面都将被验证(忽略first_page_index)。 默认值:-1。
[in]progress_callback由用户实现的进度回调,可用于获取进度数据。 这可以是NULL。默认值:NULL
返回
ResultInformation对象。