Foxit PDF SDK

Public Member Functions | List of all members
foxit::pdf::actions::ImportDataAction Class Reference
Inheritance diagram for foxit::pdf::actions::ImportDataAction:

## Public Member Functions
| ImportDataAction (const 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 (const 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 (const Action &action)
| Constructor, with another action object. More...
| Action (const PDFDoc &document, objects::PDFDictionary *action_dict)
| Constructor, with parameters. More...
| ~Action ()
| Destructor.
objects::PDFDictionary * | GetDict () const
| 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...
Type | GetType ()
| Get action type. More...
void | InsertSubAction (int index, const Action &sub_action)
| Insert a new sub-action to the location specified by index. More...
bool | IsEmpty () const
| Check whether current object is empty or not. More...
bool | operator!= (const Action &other) const
| Not equal operator. More...
Action & | operator= (const Action &other)
| Assign operator. More...
bool | operator== (const Action &other) const
| Equal operator. 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, const Action &sub_action)
| Set a sub-action by index. More...
Public Member Functions inherited from foxit::Base
FS_HANDLE | Handle () const
| Get the handle of current object. More...

## Additional Inherited Members
Public Types inherited from foxit::pdf::actions::Action
enum | NewWindowFlag { e_NewWindowFlagFalse = 0, e_NewWindowFlagTrue = 1, e_NewWindowFlagNone = 2 }
| Enumeration for new window flag. More...
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 }
| Enumeration for action type. More...
Static Public Member Functions inherited from foxit::pdf::actions::Action
static Action | Create (const foxit::pdf::PDFDoc &document, 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 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 | ( | const Action & | action | ) |
| explicit

Constructor, with parent class object.

Parameters

  [in] | action | Parent class object.

## Member Function Documentation

## ◆ GetFDFFileSpec()

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

## ◆ SetFDFFileSpec()

void foxit::pdf::actions::ImportDataAction::SetFDFFileSpec | ( | const FileSpec & | 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_specification | A file specification object which represents a FDF file. It should be valid and be in the same PDF document as current action.

Returns
  None.