fsdk.FileSpec类 参考

Public 成员函数
def	Embed (file_path)
	嵌入由文件路径指定的文件的全部内容。 更多...
def	Embed (pdf_object)
	（仅在PDF 2.0中支持）当当前文件规范对象用作关联文件时， 嵌入PDF流对象或引用PDF流对象的PDF引用对象的全部内容。 更多...
def	Embed (stream)
	使用 fsdk.StreamCallback 嵌入文件。 更多...
def	ExportToFile (path)
	将当前文件规范中表示的文件数据直接导出到文件中。 更多...
def	ExportToFileStream (stream)
	通过流回调对象导出当前文件规范中表示的文件数据。 更多...
def	GetAssociteFileRelationship ()
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，获取关联文件关系。 更多...
def	GetChecksum ()
	获取嵌入文件的校验和。 更多...
def	GetCompressedEmbeddedFileSize ()
	获取嵌入文件的压缩文件大小。 更多...
def	GetCreationDateTime ()
	获取关于嵌入文件创建时间的创建日期和时间。 更多...
def	GetDescription ()
	获取与当前文件规范关联的描述性文本。 更多...
def	GetDict ()
	获取当前文件规范的PDF字典。 更多...
def	GetFileData ()
	获取嵌入文件的文件数据。 更多...
def	GetFileName ()
	获取文件名。 更多...
def	GetFileSize ()
	获取嵌入文件的大小（未压缩文件大小）。 更多...
def	GetModifiedDateTime ()
	获取关于嵌入文件最后修改时间的修改日期和时间。 更多...
def	GetSubtype ()
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时， 获取嵌入文件的"Subtype"键的MIME类型值。 更多...
def	IsEmbedded ()
	检查当前文件规范对象是否表示嵌入文件。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	SetAssociteFileRelationship (associfile_relationship)
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，设置关联文件关系。 更多...
def	SetChecksum (checksum)
	为嵌入文件设置校验和。（不影响本地文件） 更多...
def	SetCreationDateTime (date_time)
	为嵌入文件设置创建日期和时间。（不影响本地文件） 更多...
def	SetDescription (description)
	设置与当前文件规范关联的描述性文本。 更多...
def	SetFileName (file_name)
	设置文件名。 更多...
def	SetModifiedDateTime (date_time)
	为嵌入文件设置最后修改日期和时间。（不影响本地文件） 更多...
def	SetSubtype (subtype)
	（仅在PDF 2.0中支持）当当前文件规范用作关联文件时， 为嵌入文件的"Subtype"键设置MIME类型值。（不影响本地文件） 更多...

详细描述

PDF文件可以通过使用文件规范来引用另一个文件的内容。 文件规范可以简单地表示另一个文件的文件路径，或表示另一个文件的全部内容， 该内容被嵌入到当前PDF文件中。

成员函数说明

Embed() [1/3]

def fsdk.FileSpec.Embed

(

file_path

)

嵌入由文件路径指定的文件的全部内容。

当此函数成功时，指定文件的全部内容将被嵌入到 当前文件规范所属的PDF文档中。

参数

[in]

file_path

现有本地文件的完整路径。

返回

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

Embed() [2/3]

def fsdk.FileSpec.Embed

(

pdf_object

)

（仅在PDF 2.0中支持）当当前文件规范对象用作关联文件时， 嵌入PDF流对象或引用PDF流对象的PDF引用对象的全部内容。

当此函数成功时，指定PDF流对象的全部内容将被嵌入到 当前文件规范所属的PDF文档中。

参数

[in]

pdf_object

一个有效的PDF对象。它应该是PDF流对象或引用PDF流对象的PDF引用对象。

返回

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

Embed() [3/3]

def fsdk.FileSpec.Embed

(

stream

)

使用 fsdk.StreamCallback 嵌入文件。

当此函数成功时，请保持输入的流回调对象有效， 直到PDF文件（当前文件规范所属的）被保存或关闭。

参数

[in]

stream

用户实现的 fsdk.StreamCallback 对象， 用于读取文件内容。

返回

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

ExportToFile()

def fsdk.FileSpec.ExportToFile

(

path

)

将当前文件规范中表示的文件数据直接导出到文件中。

参数

[in]

path

将保存数据的文件的完整路径。

返回

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

ExportToFileStream()

def fsdk.FileSpec.ExportToFileStream

(

stream

)

通过流回调对象导出当前文件规范中表示的文件数据。

参数

[in]

stream

用户实现的 fsdk.StreamCallback 对象，用于保存文件数据。

返回

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

GetAssociteFileRelationship()

def fsdk.FileSpec.GetAssociteFileRelationship

(

)

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，获取关联文件关系。

返回

关联文件关系。请参考从 fsdk.AssociatedFilesE_RelationshipSource 开始的值，这应该是这些值中的一个。

GetChecksum()

def fsdk.FileSpec.GetChecksum

(

)

获取嵌入文件的校验和。

此函数仅在当前文件规范对象表示嵌入文件时有用。 16字节字符串，是未压缩嵌入文件字节的校验和。 校验和通过对嵌入文件流的字节应用标准MD5消息摘要算法来计算。
如果当前文件规范对象不表示嵌入文件，此函数将返回空字符串。

返回

校验和字符串。

GetCompressedEmbeddedFileSize()

def fsdk.FileSpec.GetCompressedEmbeddedFileSize

(

)

获取嵌入文件的压缩文件大小。

此函数仅在当前文件规范对象表示嵌入文件时有用。 如果当前文件规范对象不表示嵌入文件，此函数将直接返回0。

返回

嵌入文件的压缩文件大小。

GetCreationDateTime()

def fsdk.FileSpec.GetCreationDateTime

(

)

获取关于嵌入文件创建时间的创建日期和时间。

此函数仅在当前文件规范对象表示嵌入文件时有用。 如果当前文件规范对象不表示嵌入文件，此函数将 返回一个所有值都为0的日期和时间对象。

返回

嵌入文件的创建日期时间。

GetDescription()

def fsdk.FileSpec.GetDescription

(

)

获取与当前文件规范关联的描述性文本。

返回

描述性文本。

GetDict()

def fsdk.FileSpec.GetDict

(

)

获取当前文件规范的PDF字典。

返回

PDF字典对象。如果有任何错误，此函数将返回null。

GetFileData()

def fsdk.FileSpec.GetFileData

(

)

获取嵌入文件的文件数据。

返回

一个 fsdk.FileReaderCallback 对象。用户可以调用 fsdk.FileReaderCallback 类中的函数来读取文件数据。

GetFileName()

def fsdk.FileSpec.GetFileName

(

)

获取文件名。

返回

文件名。如果找不到文件名，此函数将返回空字符串。

GetFileSize()

def fsdk.FileSpec.GetFileSize

(

)

获取嵌入文件的大小（未压缩文件大小）。

此函数仅在当前文件规范对象表示嵌入文件时有用。 如果当前文件规范对象不表示嵌入文件，此函数将直接返回0。

返回

嵌入文件的文件大小（未压缩文件大小）。

GetModifiedDateTime()

def fsdk.FileSpec.GetModifiedDateTime

(

)

获取关于嵌入文件最后修改时间的修改日期和时间。

此函数仅在当前文件规范对象表示嵌入文件时有用。 如果当前文件规范对象不表示嵌入文件，此函数将 返回一个所有值都为0的日期和时间对象。

返回

嵌入文件的修改日期时间。

GetSubtype()

def fsdk.FileSpec.GetSubtype

(

)

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时， 获取嵌入文件的"Subtype"键的MIME类型值。

此函数仅在当前文件规范对象表示嵌入文件且用作关联文件时有用。

返回

子类型字符串。

IsEmbedded()

def fsdk.FileSpec.IsEmbedded

(

)

检查当前文件规范对象是否表示嵌入文件。

返回

true表示当前文件规范对象表示嵌入文件。 false表示当前文件规范对象不表示嵌入文件。

IsEmpty()

def fsdk.FileSpec.IsEmpty

(

)

检查当前对象是否为空。

当当前对象为空时，意味着当前对象是无用的。

返回

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

SetAssociteFileRelationship()

def fsdk.FileSpec.SetAssociteFileRelationship

(

associfile_relationship

)

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时，设置关联文件关系。

对于新创建的关联文件规范对象，此函数是必需的。

参数

[in]

associfile_relationship

要设置的关联文件关系。请参考从 fsdk.AssociatedFilesE_RelationshipSource 开始的值， 这将是这些值中的一个。

返回

无。

SetChecksum()

def fsdk.FileSpec.SetChecksum

(

checksum

)

为嵌入文件设置校验和。（不影响本地文件）

此函数仅在当前文件规范对象表示嵌入文件时有用。
16字节字符串，是未压缩嵌入文件字节的校验和。 校验和通过对嵌入文件流的字节应用标准MD5消息摘要算法来计算。

参数

[in]

checksum

要设置的校验和。

返回

无。

SetCreationDateTime()

def fsdk.FileSpec.SetCreationDateTime

(

date_time

)

为嵌入文件设置创建日期和时间。（不影响本地文件）

此函数仅在当前文件规范对象表示嵌入文件时有用。

参数

[in]

date_time

要设置的创建日期和时间。

返回

无。

SetDescription()

def fsdk.FileSpec.SetDescription

(

description

)

设置与当前文件规范关联的描述性文本。

参数

[in]

description

要设置的描述性文本。不应该是空字符串。

返回

无。

SetFileName()

def fsdk.FileSpec.SetFileName

(

file_name

)

设置文件名。

对于新的文件规范对象（不是从现有文件规范PDF对象构造的），此函数是必需的。

参数

[in]

file_name

要设置的文件名。不应该是空字符串。

返回

无。

SetModifiedDateTime()

def fsdk.FileSpec.SetModifiedDateTime

(

date_time

)

为嵌入文件设置最后修改日期和时间。（不影响本地文件）

此函数仅在当前文件规范对象表示嵌入文件时有用。

参数

[in]

date_time

要设置的最后修改日期和时间。

返回

无。

SetSubtype()

def fsdk.FileSpec.SetSubtype

(

subtype

)

（仅在PDF 2.0中支持）当当前文件规范用作关联文件时， 为嵌入文件的"Subtype"键设置MIME类型值。（不影响本地文件）

此函数仅在当前文件规范对象表示嵌入文件且用作关联文件时有用。

参数

[in]

subtype

有效的MIME类型值。默认值："application/octet-stream"。

返回

无。