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

Public Member Functions

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

Additional Inherited Members

- Static Public Attributes inherited from FoxitPDFSDKPython2.Action
 Create = _fsdk.Action_Create
 Create a new action, for specified action type. More...
 
 e_NewWindowFlagFalse = _fsdk.Action_e_NewWindowFlagFalse
 "NewWindow" flag is false.
 
 e_NewWindowFlagNone = _fsdk.Action_e_NewWindowFlagNone
 No "NewWindow" flag.
 
 e_NewWindowFlagTrue = _fsdk.Action_e_NewWindowFlagTrue
 "NewWindow" flag is true.
 
 e_TypeGoto = _fsdk.Action_e_TypeGoto
 Action type: go-to action.
 
 e_TypeGoTo3DView = _fsdk.Action_e_TypeGoTo3DView
 Action type: go-to-3D-view action.
 
 e_TypeGoToE = _fsdk.Action_e_TypeGoToE
 Action type: embedded go-to action.
 
 e_TypeGoToR = _fsdk.Action_e_TypeGoToR
 Action type: remote go-to action.
 
 e_TypeHide = _fsdk.Action_e_TypeHide
 Action type: hide action.
 
 e_TypeImportData = _fsdk.Action_e_TypeImportData
 Action type: import-data action.
 
 e_TypeJavaScript = _fsdk.Action_e_TypeJavaScript
 Action type: JavaScript action.
 
 e_TypeLaunch = _fsdk.Action_e_TypeLaunch
 Action type: launch action.
 
 e_TypeMovie = _fsdk.Action_e_TypeMovie
 Action type: movie action.
 
 e_TypeNamed = _fsdk.Action_e_TypeNamed
 Action type: named action.
 
 e_TypeRendition = _fsdk.Action_e_TypeRendition
 Action type: rendition action.
 
 e_TypeResetForm = _fsdk.Action_e_TypeResetForm
 Action type: reset-form action.
 
 e_TypeSetOCGState = _fsdk.Action_e_TypeSetOCGState
 Action type: set-OCG-state action.
 
 e_TypeSound = _fsdk.Action_e_TypeSound
 Action type: sound action.
 
 e_TypeSubmitForm = _fsdk.Action_e_TypeSubmitForm
 Action type: submit-form action.
 
 e_TypeThread = _fsdk.Action_e_TypeThread
 Action type: thread action.
 
 e_TypeTrans = _fsdk.Action_e_TypeTrans
 Action type: transition action.
 
 e_TypeUnknown = _fsdk.Action_e_TypeUnknown
 Action type: unknown action.
 
 e_TypeURI = _fsdk.Action_e_TypeURI
 Action type: uniform resource identifier (URI) action.
 

Detailed Description

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

See also
Action

Constructor & Destructor Documentation

◆ HideAction()

def FoxitPDFSDKPython2.HideAction.HideAction (   action)

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Member Function Documentation

◆ GetFieldNames()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.HideAction.GetHideState ( )

Get the hide state.

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

◆ SetFieldNames()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.Field.GetName .
Returns
None.

◆ SetHideState()

def FoxitPDFSDKPython2.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.