Foxit PDF SDK
foxit::pdf::actions::HideAction类 参考
类 foxit::pdf::actions::HideAction 继承关系图:
foxit::pdf::actions::Action foxit::Base

Public 成员函数

 HideAction (const Action &action)
 构造函数,使用父类对象。 更多...
 
WStringArray GetFieldNames ()
 从当前隐藏动作的数组中获取所有字段名称。 更多...
 
bool GetHideState ()
 获取隐藏状态。 更多...
 
void SetFieldNames (const WStringArray &field_names)
 设置字段名称数组。 更多...
 
void SetHideState (bool is_hide)
 设置隐藏状态。 更多...
 
- Public 成员函数 继承自 foxit::pdf::actions::Action
 Action (const PDFDoc &document, objects::PDFDictionary *action_dict)
 构造函数,带参数。 更多...
 
 Action (const Action &action)
 构造函数,使用另一个动作对象。 更多...
 
 ~Action ()
 析构函数。
 
objects::PDFDictionaryGetDict () 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
 不等于操作符。 更多...
 
Actionoperator= (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::HideAction派生自Action,提供用于 获取/设置隐藏动作数据的函数。

参见
Action

构造及析构函数说明

◆ HideAction()

foxit::pdf::actions::HideAction::HideAction ( const Action action)
explicit

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

参数
[in]action父类对象。

成员函数说明

◆ GetFieldNames()

WStringArray foxit::pdf::actions::HideAction::GetFieldNames ( )

从当前隐藏动作的数组中获取所有字段名称。

隐藏动作可以有一个数组,标识要隐藏或显示哪些字段。 此数组对于隐藏动作是必需的。

返回
字段名称数组。

◆ GetHideState()

bool foxit::pdf::actions::HideAction::GetHideState ( )

获取隐藏状态。

返回
true表示隐藏指定字段,false表示显示指定字段。

◆ SetFieldNames()

void foxit::pdf::actions::HideAction::SetFieldNames ( const WStringArray field_names)

设置字段名称数组。

隐藏动作可以有一个数组,标识要隐藏或显示哪些字段。 此数组对于隐藏动作是必需的。因此,对于新的隐藏动作,用户应 调用此函数来设置数组。

参数
[in]field_names表单字段名称的数组,用于指定要隐藏或显示哪些字段。 字段名称可以通过函数interform::Field::GetName获取。
返回
无。

◆ SetHideState()

void foxit::pdf::actions::HideAction::SetHideState ( bool  is_hide)

设置隐藏状态。

对于新的隐藏动作,如果未设置隐藏状态,默认使用true

参数
[in]is_hidetrue表示隐藏指定字段,false表示显示指定字段。
返回
无。