Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit.pdf.actions.LaunchAction类 参考
类 foxit.pdf.actions.LaunchAction 继承关系图:

## Public 成员函数
| LaunchAction (Action action)
| 构造函数，使用父类对象。 更多...
FileSpec | GetFileSpec ()
| 获取指定要启动的应用程序或要打开或打印的文档的文件规范。 更多...
Action.NewWindowFlag | GetNewWindowFlag ()
| 获取用于决定是否在新窗口中打开目标文档的标志。 更多...
string | GetWinAppOperation ()
| (Windows特定启动参数) 获取操作名称。 更多...
string | GetWinAppParameter ()
| (Windows特定启动参数) 获取传递给指定应用程序的参数字符串。 更多...
string | GetWinDefaultDirectory ()
| (Windows特定启动参数) 获取标准DOS语法的默认目录。 更多...
string | GetWinFileName ()
| (Windows特定启动参数) 获取要启动的应用程序或 要打开或打印的文档的文件名。 更多...
void | SetFileSpec (FileSpec file_specification)
| 设置指定要启动的应用程序或要打开或打印的文档的文件规范。 更多...
void | SetNewWindowFlag (Action.NewWindowFlag flag)
| 设置用于决定是否在新窗口中打开目标文档的标志。 更多...
void | SetWinLaunchParameter (string file_name, string default_directory, string operation, string app_parameter)
| (Windows特定启动参数)设置Windows特定启动参数。 更多...
Public 成员函数 继承自 foxit.pdf.actions.Action
| Action (PDFDoc document, PDFDictionary action_dict)
| 构造函数，带参数。 更多...
| Action (Action action)
| 构造函数，使用另一个动作对象。 更多...
PDFDictionary | GetDict ()
| 获取当前对象的PDF字典。 更多...
PDFDoc | GetDocument ()
| 获取当前动作所属的PDF文档。 更多...
Action | GetSubAction (int index)
| 按索引获取子动作。 更多...
int | GetSubActionCount ()
| 获取子动作的数量。 更多...
Action.Type | GetType ()
| 获取动作类型。 更多...
void | InsertSubAction (int index, Action sub_action)
| 在指定索引位置插入新的子动作。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...
void | RemoveAllSubActions ()
| 移除所有子动作。 更多...
void | RemoveSubAction (int index)
| 移除指定索引的子动作。 更多...
void | SetSubAction (int index, Action sub_action)
| 按索引设置子动作。 更多...

## 额外继承的成员函数
Public 类型 继承自 foxit.pdf.actions.Action
enum | NewWindowFlag { NewWindowFlag.e_NewWindowFlagFalse = 0, NewWindowFlag.e_NewWindowFlagTrue = 1, NewWindowFlag.e_NewWindowFlagNone = 2 }
| 新窗口标志枚举。 更多...
enum | Type { Type.e_TypeUnknown = 0, Type.e_TypeGoto = 1, Type.e_TypeGoToR = 2, Type.e_TypeGoToE = 3, Type.e_TypeLaunch = 4, Type.e_TypeThread = 5, Type.e_TypeURI = 6, Type.e_TypeSound = 7, Type.e_TypeMovie = 8, Type.e_TypeHide = 9, Type.e_TypeNamed = 10, Type.e_TypeSubmitForm = 11, Type.e_TypeResetForm = 12, Type.e_TypeImportData = 13, Type.e_TypeJavaScript = 14, Type.e_TypeSetOCGState = 15, Type.e_TypeRendition = 16, Type.e_TypeTrans = 17, Type.e_TypeGoTo3DView = 18 }
| 动作类型枚举。 更多...
静态 Public 成员函数 继承自 foxit.pdf.actions.Action
static Action | Create (PDFDoc document, Action.Type action_type)
| 为指定的动作类型创建新动作。 更多...

## 详细描述

启动动作是启动应用程序，通常用于打开文件。 类foxit.pdf.actions.LaunchAction 派生自Action ，提供用于 获取/设置启动动作数据的函数。

参见
  Action

## 构造及析构函数说明

## ◆ LaunchAction()

foxit.pdf.actions.LaunchAction.LaunchAction | ( | Action | action | ) |
| inline

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

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetFileSpec()

FileSpec foxit.pdf.actions.LaunchAction.GetFileSpec | ( |  | ) |
| inline

获取指定要启动的应用程序或要打开或打印的文档的文件规范。

返回
  文件规范对象。如果返回的文件规范对象的函数FileSpec.IsEmpty 的返回值为true，则表示未找到此类属性。

## ◆ GetNewWindowFlag()

Action.NewWindowFlag foxit.pdf.actions.LaunchAction.GetNewWindowFlag | ( |  | ) |
| inline

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

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

  - foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。

  - foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。

  - foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagNone 表示 没有此类标志，查看器应用程序应根据 当前用户首选项行为。

## ◆ GetWinAppOperation()

string foxit.pdf.actions.LaunchAction.GetWinAppOperation | ( |  | ) |
| inline

(Windows特定启动参数) 获取操作名称。

操作名称的标准字符串为：

- "open"：打开文档。

- "print"：打印文档

如果Windows特定启动参数的文件名表示应用程序， 操作名称对当前动作将无用。

返回
  操作名称。

## ◆ GetWinAppParameter()

string foxit.pdf.actions.LaunchAction.GetWinAppParameter | ( |  | ) |
| inline

(Windows特定启动参数) 获取传递给指定应用程序的参数字符串。

如果Windows特定启动参数的文件名表示文档， 应用程序参数字符串将被忽略。

返回
  参数字符串。

## ◆ GetWinDefaultDirectory()

string foxit.pdf.actions.LaunchAction.GetWinDefaultDirectory | ( |  | ) |
| inline

(Windows特定启动参数) 获取标准DOS语法的默认目录。

返回
  默认目录。

## ◆ GetWinFileName()

string foxit.pdf.actions.LaunchAction.GetWinFileName | ( |  | ) |
| inline

(Windows特定启动参数) 获取要启动的应用程序或 要打开或打印的文档的文件名。

返回
  文件名。

## ◆ SetFileSpec()

void foxit.pdf.actions.LaunchAction.SetFileSpec | ( | FileSpec | file_specification | ) |
| inline

设置指定要启动的应用程序或要打开或打印的文档的文件规范。

参数

  [in] | file_specification | 有效的文件规范对象。此对象应与当前动作对象 在同一个文档中。

返回
  无。

## ◆ SetNewWindowFlag()

void foxit.pdf.actions.LaunchAction.SetNewWindowFlag | ( | Action.NewWindowFlag | flag | ) |
| inline

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

参数

  [in] | flag | 新窗口标志。应为以下值之一： foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。 foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。 foxit.pdf.actions.Action.NewWindowFlag.e_NewWindowFlagNone 表示 不需要此类标志，查看器应用程序应根据 当前用户首选项行为。

返回
  无。

## ◆ SetWinLaunchParameter()

void foxit.pdf.actions.LaunchAction.SetWinLaunchParameter | ( | string | file_name,
|  | string | default_directory,
|  | string | operation,
|  | string | app_parameter
| ) |  |
| inline

(Windows特定启动参数)设置Windows特定启动参数。

此函数用于设置Windows特定启动参数。 参数file_name是必需的，可以表示应用程序或文档。 当参数file_name表示应用程序时，参数operation和 app_parameter无用。

参数

  [in] | file_name | 要启动的应用程序或要打开或打印的文档的文件名。 不应为空字符串。
  [in] | default_directory | 标准DOS语法的默认目录。
  [in] | operation | 操作名称。这可以是空字符串。如果不是空字符串， 应为以下字符串之一： "open"：打开文档。 "print"：打印文档
  [in] | app_parameter | 传递给指定应用程序的参数字符串。

返回
  无。