Foxit PDF SDK

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

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

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

## 详细描述

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

参见
  Action

## 构造及析构函数说明

## ◆ LaunchAction()

foxit::pdf::actions::LaunchAction::LaunchAction | ( | const Action & | action | ) |
| explicit

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

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetFileSpec()

FileSpec foxit::pdf::actions::LaunchAction::GetFileSpec | ( |  | ) |

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

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

## ◆ GetNewWindowFlag()

NewWindowFlag foxit::pdf::actions::LaunchAction::GetNewWindowFlag | ( |  | ) |

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

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

## ◆ GetWinAppOperation()

String foxit::pdf::actions::LaunchAction::GetWinAppOperation | ( |  | ) |

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

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

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

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

返回
  操作名称。

## ◆ GetWinAppParameter()

String foxit::pdf::actions::LaunchAction::GetWinAppParameter | ( |  | ) |

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

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

返回
  参数字符串。

## ◆ GetWinDefaultDirectory()

String foxit::pdf::actions::LaunchAction::GetWinDefaultDirectory | ( |  | ) |

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

返回
  默认目录。

## ◆ GetWinFileName()

String foxit::pdf::actions::LaunchAction::GetWinFileName | ( |  | ) |

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

返回
  文件名。

## ◆ SetFileSpec()

void foxit::pdf::actions::LaunchAction::SetFileSpec | ( | const FileSpec & | file_specification | ) |

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

参数

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

返回
  无。

## ◆ SetNewWindowFlag()

void foxit::pdf::actions::LaunchAction::SetNewWindowFlag | ( | NewWindowFlag | flag | ) |

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

参数

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

返回
  无。

## ◆ SetWinLaunchParameter()

void foxit::pdf::actions::LaunchAction::SetWinLaunchParameter | ( | const String & | file_name,
|  | const String & | default_directory,
|  | const String & | operation,
|  | const String & | 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 | 传递给指定应用程序的参数字符串。

返回
  无。