fsdk.EmbeddedGotoTarget类 参考

Public 成员函数
def	GetAttachedFileName ()
	获取嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。 更多...
def	GetDict ()
	获取当前对象的PDF字典。 更多...
def	GetFileAttachmentAnnotIndex ()
	获取指定页面中文件附件注释的注释索引。 更多...
def	GetPageIndex ()
	获取指定包含目标文件附件注释的页面的页面索引。 更多...
def	GetRelationship ()
	获取当前目标对象和当前目标对象所属对象之间的关系。 更多...
def	GetTarget ()
	获取指定到目标文档的附加路径信息的目标。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	SetAttachedFileName (embed_file_name)
	设置嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。 更多...
def	SetFileAttachmentAnnotIndex (annot_index)
	设置指定页面中文件附件注释的注释索引。 更多...
def	SetPageIndex (page_index)
	设置指定包含目标文件附件注释的页面的页面索引。 更多...
def	SetRelationship (relationship)
	设置当前目标对象和当前目标对象所属对象之间的关系。 更多...
def	SetTarget (target)
	设置指定到目标文档的附加路径信息的目标。 更多...

详细描述

嵌入转到动作的目标是目标所在的文档。

参见

EmbeddedGotoAction

成员函数说明

GetAttachedFileName()

def fsdk.EmbeddedGotoTarget.GetAttachedFileName

(

)

获取嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。

这仅在关系为"C"时有用。如果此属性是有效字符串， 那意味着目标文件是在"EmbeddedFiles"名称树中定义的嵌入文件。

返回

嵌入文件名。

GetDict()

def fsdk.EmbeddedGotoTarget.GetDict

(

)

获取当前对象的PDF字典。

返回

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

GetFileAttachmentAnnotIndex()

def fsdk.EmbeddedGotoTarget.GetFileAttachmentAnnotIndex

(

)

获取指定页面中文件附件注释的注释索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定指定页面中的文件附件注释。 函数fsdk.EmbeddedGotoTarget.GetPageIndex 可用于 获取指定包含目标文件附件注释的页面的页面索引。

返回

指定文件附件注释的注释索引。有效值从0开始。 -1表示没有此类属性。

GetPageIndex()

def fsdk.EmbeddedGotoTarget.GetPageIndex

(

)

获取指定包含目标文件附件注释的页面的页面索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关。此属性仅指定包含文件附件注释的页面。 函数fsdk.EmbeddedGotoTarget.GetFileAttachmentAnnotIndex 可用于获取目标文件附件注释的注释索引。

返回

页面索引。有效值从0开始。-1表示没有此类属性。

GetRelationship()

def fsdk.EmbeddedGotoTarget.GetRelationship

(

)

获取当前目标对象和当前目标对象所属对象之间的关系。

关系是当前目标对象和当前目标对象所属对象之间的关系。目前，关系可以是以下之一：

• "P"：当前目标对象是当前目标对象所属对象的父对象。

• "C"：当前目标对象是当前目标对象所属对象的子对象。

返回

关系字符串。

GetTarget()

def fsdk.EmbeddedGotoTarget.GetTarget

(

)

获取指定到目标文档的附加路径信息的目标。

返回

嵌入转到目标对象。如果返回的嵌入转到目标对象的函数fsdk.EmbeddedGotoTarget.IsEmpty 的返回值为true，那意味着当前目标对象表示最终目标文件。

IsEmpty()

def fsdk.EmbeddedGotoTarget.IsEmpty

(

)

检查当前对象是否为空。

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

返回

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

SetAttachedFileName()

def fsdk.EmbeddedGotoTarget.SetAttachedFileName

(

embed_file_name

)

设置嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件是 在"EmbeddedFiles"名称树中定义的嵌入文件。

参数

[in]

embed_file_name

嵌入文件的名称。

返回

无。

SetFileAttachmentAnnotIndex()

def fsdk.EmbeddedGotoTarget.SetFileAttachmentAnnotIndex

(

annot_index

)

设置指定页面中文件附件注释的注释索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定指定页面中的文件附件注释。 函数fsdk.EmbeddedGotoTarget.SetPageIndex 可用于 设置指定包含目标文件附件注释的页面的页面索引。

参数

[in]

annot_index

指定文件附件注释的注释索引。 有效范围：从0到(count-1)。count表示 指定页面中的注释数量。

返回

无。

SetPageIndex()

def fsdk.EmbeddedGotoTarget.SetPageIndex

(

page_index

)

设置指定包含目标文件附件注释的页面的页面索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定包含文件附件注释的页面。 函数fsdk.EmbeddedGotoTarget.SetFileAttachmentAnnotIndex 可用于设置目标文件附件注释的注释索引。

参数

[in]

page_index

指定包含目标文件附件注释的页面的页面索引。 有效范围：从0到(count-1)。count表示 当前目标PDF文件的页面数量。

返回

无。

SetRelationship()

def fsdk.EmbeddedGotoTarget.SetRelationship

(

relationship

)

设置当前目标对象和当前目标对象所属对象之间的关系。

关系是当前目标对象和当前目标对象所属对象之间的关系。目前，关系可以是以下之一：

• "P"：当前目标对象是当前目标对象所属对象的父对象。

• "C"：当前目标对象是当前目标对象所属对象的子对象。

参数

[in]

relationship

应该是以下字符串之一："P"、"C"。

返回

无。

SetTarget()

def fsdk.EmbeddedGotoTarget.SetTarget

(

target

)

设置指定到目标文档的附加路径信息的目标。

参数

[in]

target

嵌入转到目标对象。如果返回的嵌入转到目标对象的函数fsdk.EmbeddedGotoTarget.IsEmpty 的返回值为true，那意味着当前目标对象表示最终目标文件。

返回

无。