Foxit PDF SDK
FoxitPDFSDKPython3.ImportDataAction Class Reference
Inheritance diagram for FoxitPDFSDKPython3.ImportDataAction:
FoxitPDFSDKPython3.Action FoxitPDFSDKPython3.Base

Public Member Functions

def ImportDataAction (action)
 Constructor, with parent class object.
More...
 
def GetFDFFileSpec ()
 Get the file specification for the FDF file, from which to import form data.
More...
 
def SetFDFFileSpec (file_specification)
 Set a file specification of a FDF file, from which to import form data.
More...
 
- Public Member Functions inherited from FoxitPDFSDKPython3.Action
def Action (action)
 Constructor, with another action object.
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 Member Functions inherited from FoxitPDFSDKPython3.Action
def Create (dictionary)
 Create a new action, for specified action type.
More...
 
- Static Public Attributes inherited from FoxitPDFSDKPython3.Action
 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

Import-data action is to import field values from a FDF file. Class FoxitPDFSDKPython3.ImportDataAction is derived from Action and offers functions to get/set import-data action data.

See also
Action

Constructor & Destructor Documentation

◆ ImportDataAction()

def FoxitPDFSDKPython3.ImportDataAction.ImportDataAction (   action)

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Member Function Documentation

◆ GetFDFFileSpec()

def FoxitPDFSDKPython3.ImportDataAction.GetFDFFileSpec ( )

Get the file specification for the FDF file, from which to import form data.

Returns
A file specification object. If the return value of function FoxitPDFSDKPython3.FileSpec.IsEmpty for the returned file specification object is true, that means no such object is found.

◆ SetFDFFileSpec()

def FoxitPDFSDKPython3.ImportDataAction.SetFDFFileSpec (   file_specification)

Set a file specification of a FDF file, from which to import form data.

File specification of a FDF file is necessary for an import-data action. So, for a new import-data action, user should call this function to set the file specification of a FDF file; otherwise the action will be useless.

Parameters
[in]file_specificationA file specification object which represents a FDF file. It should be valid and be in the same PDF document as current action.
Returns
None.