Public 成员函数
	constructor (document)
	从 PDF 文档对象构造的构造函数。更多...

	GetCustomerKeys ()
	从元数据中获取自定义键。更多...

	GetModifiedDateTime ()
	获取修改日期时间。更多...

	GetValues (key)
	获取元数据值。更多...

	HasKey (key) GetCreationDateTime()
	检查相关 PDF 文档是否具有指定的元数据键。更多...

	IsEmpty ()
	检查当前对象是否为空。更多...

	RemoveCustomerKey (key)
	删除指定的自定义键(及其相关值)。更多...

	SetCreationDateTime (date_time)
	设置创建日期时间。更多...

	SetModifiedDateTime (date_time)
	设置修改日期时间。更多...

	SetValues (key, value_array)
	设置元数据值。更多...

详细描述

在 PDF 文档中,元数据信息存储在文档的 Info 字典或元数据流中(以可扩展标记语言表示,即 XML)。当 Info 字典和元数据流中都存在某个键时,将使用最新修改的那个。
此类由 PDF 文档对象构造,用于从文档的 Info 字典和元数据流中获取或设置元数据信息。

成员函数说明

◆ constructor()

FSDK::Metadata::constructor ( document )

从 PDF 文档对象构造的构造函数。

如果指定的 PDF 文档中存在元数据信息,此函数只是构造一个元数据对象来关联这些信息。如果指定的 PDF 文档中不存在此类信息,构造的元数据对象可用于设置 PDF 文档的元数据信息。

参数

[in] document 一个有效的 PDF 文档对象。

◆ GetCustomerKeys()

FSDK::Metadata::GetCustomerKeys ( )

从元数据中获取自定义键。

在 Info 字典和元数据流中,它们有一些标准键,这些键具有相同的功能但名称不同。对于这种情况,Foxit PDF SDK 将使用 Info 字典中的标准键名。除了这些标准键之外,其他键将被视为自定义键。

返回: 自定义键的字符串数组。

◆ GetModifiedDateTime()

FSDK::Metadata::GetModifiedDateTime ( )

获取修改日期时间。

返回: 修改日期时间。如果找不到修改日期时间,将返回所有值为 0 的日期和时间对象。

◆ GetValues()

FSDK::Metadata::GetValues ( key )

获取元数据值。

对于一个元数据键,它可能包含单个或多个值。

参数

[in] key 元数据键字符串。它不应为空字符串。当前它可以是以下键之一:
"Title", "Author", "Subject", "Keywords", "Creator", "Producer", "Trapped", "CreationDate", "ModDate", "pdfaid", "InstanceID", "DocumentID"。
如果 PDF 文件支持,它也可以是一些其他自定义信息键。
对于 "CreationDate" 和 "ModDate",建议用户使用函数 FSDK.Metadata.GetCreationDateTime 和 FSDK.Metadata.GetModifiedDateTime 来获取日期信息。

返回: 元数据值的字符串数组。

◆ HasKey()

FSDK::Metadata::HasKey ( key )

检查相关 PDF 文档是否具有指定的元数据键。

参数

[in] key 要检查的元数据键。

返回: true 表示相关 PDF 文档具有指定的元数据键, 而 false 表示相关 PDF 文档不具有指定的元数据键。

获取创建日期时间。

返回: 创建日期时间。如果找不到创建日期时间,将返回所有值为 0 的日期和时间对象。

◆ IsEmpty()

FSDK::Metadata::IsEmpty ( )

检查当前对象是否为空。

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

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

◆ RemoveCustomerKey()

FSDK::Metadata::RemoveCustomerKey ( key )

删除指定的自定义键(及其相关值)。

参数

[in] key 自定义键字符串。它不应为空字符串。这应该是从函数 FSDK.Metadata.GetCustomerKeys 检索的键之一。

返回: 无。

◆ SetCreationDateTime()

FSDK::Metadata::SetCreationDateTime ( date_time )

设置创建日期时间。

参数

[in] date_time 新的创建日期时间。请参阅类 FSDK.DateTime 的注释以检查每个成员的有效范围。

返回: 无。

◆ SetModifiedDateTime()

FSDK::Metadata::SetModifiedDateTime ( date_time )

设置修改日期时间。

参数

[in] date_time 新的修改日期时间。请参阅类 FSDK.DateTime 的注释以检查每个成员的有效范围。

返回: 无。

◆ SetValues()

FSDK::Metadata::SetValues	(	key	,
		value_array
	)

设置元数据值。

此函数用于为指定的元数据键设置单个或多个值:

对于元数据键 "Author" 和 "Keywords",它们可以包含单个或多个值。
对于表示 PDFA 文件版本的元数据键 "pdfaid",其值字符串的长度始终为 2,例如 "2a"、"1a" 等。因此,只会使用参数 valueArray 中第一个元素的前两个字符。
对于其余预定义键,它们不支持多个值。因此,参数 value_array 中的所有元素将被放入一个字符串中并用 ";" 连接。然后该字符串将被视为单个值。

参数

[in]	key	元数据键字符串。它不应为空字符串。当前它可以是以下键之一: "Title", "Author", "Subject", "Keywords", "Creator", "Producer", "Trapped", "CreationDate", "ModDate", "pdfaid", "InstanceID", "DocumentID"。如果 PDF 文件支持,它也可以是一些其他自定义信息键。对于 "CreationDate" 和 "ModDate",建议用户使用 FSDK.Metadata.SetCreationDateTime 和 FSDK.Metadata.SetModifiedDateTime 来设置日期信息。
[in]	value_array	元数据值的字符串数组。

返回: 无。

Public 成员函数

详细描述

成员函数说明

◆ constructor()

◆ GetCustomerKeys()

◆ GetModifiedDateTime()

◆ GetValues()

◆ HasKey()

◆ IsEmpty()

◆ RemoveCustomerKey()

◆ SetCreationDateTime()

◆ SetModifiedDateTime()

◆ SetValues()