Foxit PDF SDK
foxit.pdf.actions.ImportDataAction Class Reference
Inheritance diagram for foxit.pdf.actions.ImportDataAction:
foxit.pdf.actions.Action foxit.common.Base

Public Member Functions

 ImportDataAction (Action action)
 Constructor, with parent class object.
More...
 
FileSpec GetFDFFileSpec ()
 Get the file specification for the FDF file, from which to import form data.
More...
 
void SetFDFFileSpec (FileSpec file_specification)
 Set a file specification of a FDF file, from which to import form data.
More...
 
- Public Member Functions inherited from foxit.pdf.actions.Action
 Action (PDFDoc document, PDFDictionary action_dict)
 Constructor, with parameters.
More...
 
 Action (Action action)
 Constructor, with another action object.
More...
 
PDFDictionary GetDict ()
 Get PDF dictionary of current object.
More...
 
PDFDoc GetDocument ()
 Get the PDF document, to which current action belongs.
More...
 
Action GetSubAction (int index)
 Get a sub-action by index.
More...
 
int GetSubActionCount ()
 Get the count of sub-actions.
More...
 
Action.Type GetType ()
 Get action type.
More...
 
void InsertSubAction (int index, Action sub_action)
 Insert a new sub-action to the location specified by index.
More...
 
bool IsEmpty ()
 Check whether current object is empty or not.
More...
 
void RemoveAllSubActions ()
 Remove all the sub-actions.
More...
 
void RemoveSubAction (int index)
 Remove a sub-action, specified by index.
More...
 
void SetSubAction (int index, Action sub_action)
 Set a sub-action by index.
More...
 

Additional Inherited Members

- Public Types inherited from foxit.pdf.actions.Action
enum  NewWindowFlag { NewWindowFlag.e_NewWindowFlagFalse = 0, NewWindowFlag.e_NewWindowFlagTrue = 1, NewWindowFlag.e_NewWindowFlagNone = 2 }
 Enumeration for new window flag.
More...
 
enum  Type {
  Type.e_TypeUnknown = 0, Type.e_TypeGoto = 1, Type.e_TypeGoToR = 2, Type.e_TypeGoToE = 3,
  Type.e_TypeLaunch = 4, Type.e_TypeThread = 5, Type.e_TypeURI = 6, Type.e_TypeSound = 7,
  Type.e_TypeMovie = 8, Type.e_TypeHide = 9, Type.e_TypeNamed = 10, Type.e_TypeSubmitForm = 11,
  Type.e_TypeResetForm = 12, Type.e_TypeImportData = 13, Type.e_TypeJavaScript = 14, Type.e_TypeSetOCGState = 15,
  Type.e_TypeRendition = 16, Type.e_TypeTrans = 17, Type.e_TypeGoTo3DView = 18
}
 Enumeration for action type.
More...
 
- Static Public Member Functions inherited from foxit.pdf.actions.Action
static Action Create (PDFDoc document, Action.Type action_type)
 Create a new action, for specified action type.
More...
 

Detailed Description

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

See also
Action

Constructor & Destructor Documentation

◆ ImportDataAction()

foxit.pdf.actions.ImportDataAction.ImportDataAction ( Action  action)
inline

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Member Function Documentation

◆ GetFDFFileSpec()

FileSpec foxit.pdf.actions.ImportDataAction.GetFDFFileSpec ( )
inline

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 FileSpec.IsEmpty for the returned file specification object is true, that means no such object is found.

◆ SetFDFFileSpec()

void foxit.pdf.actions.ImportDataAction.SetFDFFileSpec ( FileSpec  file_specification)
inline

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.