Foxit PDF SDK
FSRemoteGotoAction类 参考
类 FSRemoteGotoAction 继承关系图:
FSAction FSBase

构造函数

(id) - initWithAction:
 构造函数,使用父类对象。
更多...
 
- 构造函数 继承自 FSAction
(FSPDFDictionary *) - getDict
 获取当前对象的PDF字典。
更多...
 
(FSPDFDoc *) - getDocument
 获取当前动作所属的PDF文档。
更多...
 
(FSAction *) - getSubAction:
 按索引获取子动作。
更多...
 
(int) - getSubActionCount
 获取子动作的数量。
更多...
 
(FSActionType- getType
 获取动作类型。
更多...
 
(id) - initWithDocument:action_dict:
 构造函数,带参数。
更多...
 
(void) - insertSubAction:sub_action:
 在指定索引位置插入新的子动作。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 
(void) - removeAllSubActions
 移除所有子动作。
更多...
 
(void) - removeSubAction:
 移除指定索引的子动作。
更多...
 
(void) - setSubAction:sub_action:
 按索引设置子动作。
更多...
 

属性

FSDestination * destination
 获取目标信息。
更多...
 
NSString * destinationName
 获取在目标PDF文件中定义的目标名称。
更多...
 
FSFileSpecfileSpec
 获取指定目标文件的文件规范。

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

 

额外继承的成员函数

- 类方法 继承自 FSAction
(FSAction *) + create:action_type:
 为指定的动作类型创建新动作。
更多...
 

详细描述

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

  • 如果目标信息是目标数组,Foxit PDF SDK使用目标对象来 表示它,可以使用FSRemoteGotoAction::destination获取此值。
  • 如果目标信息是目标名称,Foxit PDF SDK使用字符串来表示它, 可以使用FSRemoteGotoAction::destinationName获取此值。 特别地,相关的目标数组在目标PDF文件中定义,而不是在当前PDF文件中。 用户可以使用类FSPDFNameTree中的函数从目标PDF文件检索实际的目标数组。

目标PDF文件和目标信息对于远程转到动作是必需的,因此用户应 确保通过FSRemoteGotoAction::fileSpecFSRemoteGotoAction::destinationFSRemoteGotoAction::destinationName 设置这两个数据,特别是对于新的远程转到动作;否则,远程转到动作将是无用的。

参见
FSAction

函数文档

◆ initWithAction:()

- (id) initWithAction: (FSAction*)  action

构造函数,使用父类对象。

参数
[in]action父类对象。

重载 FSAction .

属性说明

◆ destination

- (FSDestination *) destination
readwritenonatomicweak

获取目标信息。

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

如果返回的目标对象的函数FSDestination::isEmpty的返回值 为YES,且函数FSRemoteGotoAction::destinationName 返回空字符串,则表示远程转到动作没有任何目标信息。

◆ destinationName

- (NSString *) destinationName
readwritenonatomicweak

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

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

如果返回的目标对象的函数FSDestination::isEmpty的返回值 为YES,且函数FSRemoteGotoAction::destinationName 返回空字符串,则表示远程转到动作没有任何目标信息。