Foxit PDF SDK
FSDK.HideAction Class Reference
Inheritance diagram for FSDK.HideAction:
FSDK.Action

Public Member Functions

 constructor (action)
 Constructor, with parent class object. More...
 
 GetFieldNames ()
 Get all field names from the array of current hide action. More...
 
 GetHideState ()
 Get the hide state. More...
 
 SetFieldNames (field_names)
 Set field name array. More...
 
 SetHideState (is_hide)
 Set the hide state. More...
 
- Public Member Functions inherited from FSDK.Action
 constructor (document, action_dict)
 Constructor, with parameters. More...
 
 GetDict ()
 Get PDF dictionary of current object. More...
 
 GetDocument ()
 Get the PDF document, to which current action belongs. More...
 
 GetSubAction (index)
 Get a sub-action by index. More...
 
 GetSubActionCount ()
 Get the count of sub-actions. More...
 
 GetType ()
 Get action type. More...
 
 InsertSubAction (index, sub_action)
 Insert a new sub-action to the location specified by index. More...
 
 IsEmpty ()
 Check whether current object is empty or not. More...
 
 RemoveAllSubActions ()
 Remove all the sub-actions. More...
 
 RemoveSubAction (index)
 Remove a sub-action, specified by index. More...
 
 SetSubAction (index, sub_action)
 Set a sub-action by index. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FSDK.Action
static Create (document, action_type)
 Create a new action, for specified action type. More...
 
- Static Public Attributes inherited from FSDK.Action
static e_NewWindowFlagFalse
 Enumeration for new window flag. More...
 
static e_NewWindowFlagNone
 No "NewWindow" flag.
 
static e_NewWindowFlagTrue
 "NewWindow" flag is true.
 
static e_TypeGoto
 Action type: go-to action.
 
static e_TypeGoTo3DView
 Action type: go-to-3D-view action.
 
static e_TypeGoToE
 Action type: embedded go-to action.
 
static e_TypeGoToR
 Action type: remote go-to action.
 
static e_TypeHide
 Action type: hide action.
 
static e_TypeImportData
 Action type: import-data action.
 
static e_TypeJavaScript
 Action type: JavaScript action.
 
static e_TypeLaunch
 Action type: launch action.
 
static e_TypeMovie
 Action type: movie action.
 
static e_TypeNamed
 Action type: named action.
 
static e_TypeRendition
 Action type: rendition action.
 
static e_TypeResetForm
 Action type: reset-form action.
 
static e_TypeSetOCGState
 Action type: set-OCG-state action.
 
static e_TypeSound
 Action type: sound action.
 
static e_TypeSubmitForm
 Action type: submit-form action.
 
static e_TypeThread
 Action type: thread action.
 
static e_TypeTrans
 Action type: transition action.
 
static e_TypeUnknown
 Enumeration for action type. More...
 
static e_TypeURI
 Action type: uniform resource identifier (URI) action.
 

Detailed Description

Hide action is to hide or show specified form fields. Class FSDK.HideAction is derived from FSDK.Action and offers functions to get/set hide action data.

See also
FSDK.Action

Member Function Documentation

◆ constructor()

FSDK.HideAction.constructor ( action  )

Constructor, with parent class object.

Parameters
[in]actionParent class object.

◆ GetFieldNames()

FSDK.HideAction.GetFieldNames ( )

Get all field names from the array of current hide action.

A hide action can have an array identifying which fields to hide or to show. This array is necessary to a hide action.

Returns
An array of field names.

◆ GetHideState()

FSDK.HideAction.GetHideState ( )

Get the hide state.

Returns
true means to hide specified fields , and false means to show specified fields.

◆ SetFieldNames()

FSDK.HideAction.SetFieldNames ( field_names  )

Set field name array.

A hide action can have an array identifying which fields to hide or to show. This array is necessary to a hide action. So, for a new hide action, user should call this function to set the array.

Parameters
[in]field_namesAn array of form fields' names, to specify which fields is to hide or show. Field name can be retrieved by function FSDK.Field.GetName.
Returns
None.

◆ SetHideState()

FSDK.HideAction.SetHideState ( is_hide  )

Set the hide state.

For a new hide action, if no hide state is set, true would be used by default,

Parameters
[in]is_hidetrue means to hide specified fields, and false means to show specified fields.
Returns
None.