fsdk.RemoteGotoAction类 参考

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

详细描述

远程转到动作类似于普通转到动作，但跳转到另一个PDF文件中的目标 （非嵌入文件），而不是当前PDF文件（包含远程转到动作的文件）。
类fsdk.RemoteGotoAction 派生自Action ，提供用于 获取/设置远程转到动作数据的函数。 远程转到动作的目标信息可以表示为目标数组或目标名称：

• 如果目标信息是目标数组，Foxit PDF SDK使用目标对象来 表示它，可以使用fsdk.RemoteGotoAction.GetDestination 获取此值。

• 如果目标信息是目标名称，Foxit PDF SDK使用字符串来表示它， 可以使用fsdk.RemoteGotoAction.GetDestinationName 获取此值。 特别地，相关的目标数组在目标PDF文件中定义，而不是在当前PDF文件中。 用户可以使用类fsdk.PDFNameTree 中的函数从目标PDF文件检索实际的目标数组。

目标PDF文件和目标信息对于远程转到动作是必需的，因此用户应 确保通过fsdk.RemoteGotoAction.SetFileSpec 和 fsdk.RemoteGotoAction.SetDestination 或fsdk.RemoteGotoAction.SetDestinationName 设置这两个数据，特别是对于新的远程转到动作；否则，远程转到动作将是无用的。

参见

Action

成员函数说明

GetDestination()

def fsdk.RemoteGotoAction.GetDestination

(

)

获取目标信息。

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

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

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

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

返回

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

GetDestinationName()

def fsdk.RemoteGotoAction.GetDestinationName

(

)

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

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

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

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

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

返回

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

GetFileSpec()

def fsdk.RemoteGotoAction.GetFileSpec

(

)

获取指定目标文件的文件规范。

返回

非嵌入的文件规范对象。

GetNewWindowFlag()

def fsdk.RemoteGotoAction.GetNewWindowFlag

(

)

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

返回

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

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

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

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

SetDestination()

def fsdk.RemoteGotoAction.SetDestination

(

destination

)

设置目标信息，用于指定在目标PDF文件中要跳转到的位置。

参数

[in]

destination

要设置的有效目标对象。

返回

无。

SetDestinationName()

def fsdk.RemoteGotoAction.SetDestinationName

(

dest_name

)

设置目标名称。

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

参数

[in]

dest_name

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

返回

无。

SetFileSpec()

def fsdk.RemoteGotoAction.SetFileSpec

(

file_specification

)

设置指定目标文件的文件规范。

参数

[in]

file_specification

要设置的有效文件规范对象。此对象应属于 与当前动作相同的PDF文件。它应该表示另一个PDF文件作为 目标文件，不应表示嵌入文件。

返回

无。

SetNewWindowFlag()

def fsdk.RemoteGotoAction.SetNewWindowFlag

(

flag

)

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

参数

[in]

flag

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

返回

无。