Foxit PDF SDK

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

## Public 成员函数
| constructor (action)
| 带有 parent class object. 更多...
| GetFileSpec ()
| 获取文件规范，该规范指定要启动的应用程序或要打开或打印的文档。 更多...
| GetNewWindowFlag ()
| 获取用于决定是否在新窗口中打开目标文档的标志。 更多...
| GetWinAppOperation ()
| （Windows特定启动参数）获取操作名称。 更多...
| GetWinAppParameter ()
| （Windows特定启动参数）获取要传递给指定应用程序的参数字符串。 更多...
| GetWinDefaultDirectory ()
| （Windows特定启动参数）获取标准DOS语法的默认目录。 更多...
| GetWinFileName ()
| （Windows特定启动参数）获取要启动的应用程序或要打开或打印的文档的文件名。 更多...
| SetFileSpec (file_specification)
| 设置文件规范，该规范指定要启动的应用程序或要打开或打印的文档。 更多...
| SetNewWindowFlag (flag)
| 设置用于决定是否在新窗口中打开目标文档的标志。 更多...
| SetWinLaunchParameter (file_name, default_directory, operation, app_parameter)
| (Windows特定启动参数)设置Windows特定启动参数。 更多...
Public 成员函数 继承自 FSDK::Action
| constructor (document, action_dict)
| 带参数的构造函数。 更多...
| GetDict ()
| 获取当前对象的 PDF 字典。 更多...
| GetDocument ()
| 获取当前操作所属的 PDF 文档。 更多...
| GetSubAction (index)
| 通过索引获取子操作。 更多...
| GetSubActionCount ()
| 获取子操作的数量。 更多...
| GetType ()
| 获取操作类型。 更多...
| InsertSubAction (index, sub_action)
| 将新子操作插入到索引指定的位置。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| RemoveAllSubActions ()
| 删除所有子操作。 更多...
| RemoveSubAction (index)
| 删除由索引指定的子操作。 更多...
| SetSubAction (index, sub_action)
| 通过索引设置子操作。 更多...

## 额外继承的成员函数
静态 Public 成员函数 继承自 FSDK::Action
static | Create (document, action_type)
| 为指定的操作类型创建新操作。 更多...
静态 Public 属性 继承自 FSDK::Action
static | e_NewWindowFlagFalse
| 新窗口标志的枚举。 更多...
static | e_NewWindowFlagNone
| 无"NewWindow"标志。
static | e_NewWindowFlagTrue
| "NewWindow"标志为 true。
static | e_TypeGoto
| 操作类型：跳转操作。
static | e_TypeGoTo3DView
| 操作类型：跳转到 3D 视图操作。
static | e_TypeGoToE
| 操作类型：嵌入式跳转操作。
static | e_TypeGoToR
| 操作类型：远程跳转操作。
static | e_TypeHide
| 操作类型：隐藏操作。
static | e_TypeImportData
| 操作类型：导入数据操作。
static | e_TypeJavaScript
| 操作类型：JavaScript 操作。
static | e_TypeLaunch
| 操作类型：启动操作。
static | e_TypeMovie
| 操作类型：影片操作。
static | e_TypeNamed
| 操作类型：命名操作。
static | e_TypeRendition
| 操作类型：演绎操作。
static | e_TypeResetForm
| 操作类型：重置表单操作。
static | e_TypeSetOCGState
| 操作类型：设置 OCG 状态操作。
static | e_TypeSound
| 操作类型：声音操作。
static | e_TypeSubmitForm
| 操作类型：提交表单操作。
static | e_TypeThread
| 操作类型：线程操作。
static | e_TypeTrans
| 操作类型：过渡操作。
static | e_TypeUnknown
| 操作类型的枚举。 更多...
static | e_TypeURI
| 操作类型：统一资源标识符 (URI) 操作。

## 详细描述

启动操作用于启动应用程序，通常用于打开文件。 类 FSDK.LaunchAction 派生自 FSDK.Action，提供获取/设置启动操作数据的功能。

参见
  FSDK.Action

## 成员函数说明

## ◆ constructor()

FSDK::LaunchAction::constructor | ( | action |  | ) |

带有 parent class object.

参数

  [in] | action | Parent class object.

## ◆ GetFileSpec()

FSDK::LaunchAction::GetFileSpec | ( |  | ) |

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

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

## ◆ GetNewWindowFlag()

FSDK::LaunchAction::GetNewWindowFlag | ( |  | ) |

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

返回
  新窗口标志。它将是以下值之一：
  - FSDK.Action.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。
  - FSDK.Action.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。
  - FSDK.Action.e_NewWindowFlagNone 表示 没有此类标志，查看器应用程序应根据当前用户首选项进行操作。

## ◆ GetWinAppOperation()

FSDK::LaunchAction::GetWinAppOperation | ( |  | ) |

（Windows特定启动参数）获取操作名称。

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

- "open": 打开文档。
- "print": 打印文档

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

返回
  操作名称。

## ◆ GetWinAppParameter()

FSDK::LaunchAction::GetWinAppParameter | ( |  | ) |

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

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

返回
  参数字符串。

## ◆ GetWinDefaultDirectory()

FSDK::LaunchAction::GetWinDefaultDirectory | ( |  | ) |

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

返回
  默认目录。

## ◆ GetWinFileName()

FSDK::LaunchAction::GetWinFileName | ( |  | ) |

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

返回
  文件名。

## ◆ SetFileSpec()

FSDK::LaunchAction::SetFileSpec | ( | file_specification |  | ) |

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

参数

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

返回
  无。

## ◆ SetNewWindowFlag()

FSDK::LaunchAction::SetNewWindowFlag | ( | flag |  | ) |

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

参数

  [in] | flag | 新窗口标志。它应该是以下值之一： FSDK.Action.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。 FSDK.Action.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。 FSDK.Action.e_NewWindowFlagNone 表示 没有此类标志，查看器应用程序应根据 当前用户首选项进行操作。

返回
  无。

## ◆ SetWinLaunchParameter()

FSDK::LaunchAction::SetWinLaunchParameter | ( | file_name | ,
|  | default_directory | ,
|  | operation | ,
|  | app_parameter |
| ) |  |

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

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

参数

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

返回
  无。