fsdk.EmbeddedGotoAction类 参考

Public 成员函数
def	GetDestination ()
	获取指定在最终目标文件中跳转位置的目标信息。 更多...
def	GetDestinationName ()
	获取在最终目标PDF文件中定义的目标名称。 更多...
def	GetNewWindowFlag ()
	获取用于决定是否在新窗口中打开目标文档的标志。 更多...
def	GetRootFile ()
	获取根文件的文件规范，该根文件是目标的根文件。 更多...
def	GetTarget ()
	获取目标。 更多...
def	SetDestination (destination)
	设置指定在最终目标文件中跳转位置的目标信息。 更多...
def	SetDestinationName (dest_name)
	设置目标名称。 更多...
def	SetNewWindowFlag (flag)
	设置用于决定是否在新窗口中打开目标文档的标志。 更多...
def	SetRootFile (file_specification)
	设置根文件的文件规范，该根文件是目标的根文件。 更多...
def	SetTarget (target)
	设置目标。 更多...

详细描述

嵌入转到动作类似于远程转到动作，但允许从嵌入在另一个PDF文件中的PDF文件中跳转或跳转到该文件。 类fsdk.EmbeddedGotoTarget 派生自Action ， 提供用于获取/设置嵌入转到动作数据的函数。

参见

Action

成员函数说明

GetDestination()

def fsdk.EmbeddedGotoAction.GetDestination

(

)

获取指定在最终目标文件中跳转位置的目标信息。

对于嵌入转到动作，目标信息可以存储为目标对象 或目标名称：

• 如果是目标对象，函数fsdk.EmbeddedGotoAction.GetDestination 将 返回有效的目标对象。

• 如果是目标名称，函数fsdk.EmbeddedGotoAction.GetDestinationName 将 返回有效的字符串，目标名称将在最终目标PDF文件中定义。

如果返回的目标对象的函数fsdk.Destination.IsEmpty 的返回值 为true，且函数fsdk.EmbeddedGotoAction.GetDestinationName 返回空字符串，则表示嵌入转到动作没有任何目标信息。

返回

目标对象。如果返回的目标对象的函数fsdk.Destination.IsEmpty 的返回值 为true，请尝试函数 fsdk.EmbeddedGotoAction.GetDestinationName 。

GetDestinationName()

def fsdk.EmbeddedGotoAction.GetDestinationName

(

)

获取在最终目标PDF文件中定义的目标名称。

对于远程转到动作，目标信息可以存储为目标对象 或目标名称：

• 如果是目标对象，函数fsdk.EmbeddedGotoAction.GetDestination 将返回有效的目标对象。

• 如果是目标名称，函数fsdk.EmbeddedGotoAction.GetDestinationName 将返回有效的字符串，目标名称将在目标PDF文件中定义。

如果返回的目标对象的函数fsdk.Destination.IsEmpty 的返回值 为true，且函数fsdk.EmbeddedGotoAction.GetDestinationName 返回空字符串，则表示嵌入转到动作没有任何目标信息。

返回

目标名称。如果此函数返回空字符串，请尝试函数 fsdk.EmbeddedGotoAction.GetDestination 。

GetNewWindowFlag()

def fsdk.EmbeddedGotoAction.GetNewWindowFlag

(

)

获取用于决定是否在新窗口中打开目标文档的标志。

返回

新窗口标志。将是以下值之一：

• fsdk.ActionE_NewWindowFlagTrue 表示 在新窗口中打开目标文档。

• fsdk.ActionE_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。

• fsdk.ActionE_NewWindowFlagNone 表示 没有此类标志，查看器应用程序应根据当前用户首选项行为。

GetRootFile()

def fsdk.EmbeddedGotoAction.GetRootFile

(

)

获取根文件的文件规范，该根文件是目标的根文件。

返回

非嵌入的文件规范对象。如果返回的文件规范对象的函数fsdk.FileSpec.IsEmpty 的返回值为true，则表示包含当前嵌入转到动作的PDF文件 就是目标对象的根文件。

GetTarget()

def fsdk.EmbeddedGotoAction.GetTarget

(

)

获取目标。

返回

嵌入转到目标对象。如果返回的嵌入转到目标对象的函数fsdk.EmbeddedGotoTarget.IsEmpty 的返回值为true，则表示没有目标。

SetDestination()

def fsdk.EmbeddedGotoAction.SetDestination

(

destination

)

设置指定在最终目标文件中跳转位置的目标信息。

参数

[in]

destination

要设置的有效目标对象。

返回

无。

SetDestinationName()

def fsdk.EmbeddedGotoAction.SetDestinationName

(

dest_name

)

设置目标名称。

目标名称应该已经在目标PDF文件的"Dests"名称树中。

参数

[in]

dest_name

要设置的目标名称。不应为空字符串。

返回

无。

SetNewWindowFlag()

def fsdk.EmbeddedGotoAction.SetNewWindowFlag

(

flag

)

设置用于决定是否在新窗口中打开目标文档的标志。

参数

[in]

flag

新窗口标志。应为以下值之一： fsdk.ActionE_NewWindowFlagTrue 表示 在新窗口中打开目标文档。 fsdk.ActionE_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。 fsdk.ActionE_NewWindowFlagNone 表示 不需要此类标志，查看器应用程序应根据 当前用户首选项行为。

返回

无。

SetRootFile()

def fsdk.EmbeddedGotoAction.SetRootFile

(

file_specification

)

设置根文件的文件规范，该根文件是目标的根文件。

参数

[in]

file_specification

文件规范对象： 可以通过默认构造函数构造且不设置任何值。 在这种情况下，表示包含当前嵌入转到动作的PDF文件 也是目标的根文件。 否则，这应该是有效的文件规范对象，应该表示 另一个文件，而不是嵌入文件。文件规范对象应该 与当前动作在同一个PDF文件中。

返回

无。

SetTarget()

def fsdk.EmbeddedGotoAction.SetTarget

(

target

)

设置目标。

参数

[in]

target

嵌入转到目标对象。如果这是通过默认构造函数构造的且 没有设置任何值，则表示没有目标。

返回

无。