Foxit PDF SDK
fs_action.h
Go to the documentation of this file.
1 
15 #ifndef FS_ACTION_H_
16 #define FS_ACTION_H_
17 
18 #include "common/fs_common.h"
20 #include "common/file/fs_file.h"
21 #include "pdf/fs_rendition.h"
22 
28 namespace foxit {
32 namespace pdf {
33 // forward declaration
34 class FileSpec;
35 class PDFDoc;
36 class PDFPage;
37 namespace objects {
38  class PDFDictionary;
39 } // namespace objects
40 namespace annots {
41 class Annot;
42 class Screen;
43 } // namespace annots
44 namespace interform {
45  class Field;
46 } // namespace interform
47 
65 class Destination FS_FINAL : public Base {
66  public:
72  typedef enum _ZoomMode {
79  e_ZoomXYZ = 1,
130  } ZoomMode;
131 
132 
144  static Destination CreateXYZ(const PDFDoc& document, int page_index, float left, float top, float zoom_factor);
145 
154  static Destination CreateFitPage(const PDFDoc& document, int page_index) ;
155 
165  static Destination CreateFitHorz(const PDFDoc& document, int page_index, float top);
166 
176  static Destination CreateFitVert(const PDFDoc& document, int page_index, float left);
177 
190  static Destination CreateFitRect(const PDFDoc& document, int page_index,
191  float left, float bottom, float right, float top);
192 
201  static Destination CreateFitBBox(const PDFDoc& document, int page_index);
202 
212  static Destination CreateFitBHorz(const PDFDoc& document, int page_index, float top);
213 
223  static Destination CreateFitBVert(const PDFDoc& document, int page_index, float left);
224 
234  static Destination CreateFromPDFArray(const PDFDoc& document, objects::PDFArray* pdf_array);
235 
241  explicit Destination(objects::PDFArray* dest_array);
243  ~Destination();
249  Destination(const Destination& other);
257  Destination& operator = (const Destination& other);
258 
266  bool operator == (const Destination& other) const;
274  bool operator != (const Destination& other) const;
275 
283  bool IsEmpty() const;
284 
292  int GetPageIndex(const PDFDoc& document) const;
293 
301 
316  float GetLeft() const;
317 
329  bool IsLeftNull() const;
330 
345  float GetTop() const;
346 
358  bool IsTopNull() const;
359 
368  float GetRight() const;
369 
378  float GetBottom() const;
379 
390  float GetZoomFactor() const;
391 
398 
399  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
400  explicit Destination(FS_HANDLE handle = NULL);
401 };
402 
404 namespace actions{
418 class Action : public Base {
419  public:
425  typedef enum _Type {
464  } Type;
465 
471  typedef enum _NewWindowFlag {
478  } NewWindowFlag;
479 
480 
499  static Action Create(const foxit::pdf::PDFDoc& document, Type action_type);
500 
507  explicit Action(const PDFDoc& document, objects::PDFDictionary* action_dict);
513  Action(const Action& action);
515  ~Action();
516 
524  Action& operator = (const Action& other);
532  bool operator == (const Action& other) const ;
540  bool operator != (const Action& other) const ;
541 
549  bool IsEmpty() const;
550 
557  Type GetType();
558 
565 
572 
578  int GetSubActionCount();
579 
588  Action GetSubAction(int index);
589 
606  void SetSubAction(int index, const Action& sub_action);
607 
626  void InsertSubAction(int index, const Action& sub_action);
627 
636  void RemoveSubAction(int index);
637 
643  void RemoveAllSubActions();
644  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
645  explicit Action(FS_HANDLE handle = NULL);
646 };
647 
656 class GotoAction FS_FINAL : public Action {
657  public:
663  explicit GotoAction(const Action& action);
664 
671 
679  void SetDestination(const Destination& dest);
680 };
681 
689 class URIAction FS_FINAL : public Action {
690  public:
696  explicit URIAction(const Action& action);
697 
703  String GetURI();
704 
713  void SetURI(const String& uri);
714 
721  bool IsTrackPosition();
722 
730  void SetTrackPositionFlag(bool is_track_position);
731 
732 };
733 
741 class JavaScriptAction FS_FINAL : public Action {
742  public:
748  explicit JavaScriptAction(const Action& action);
749 
755  WString GetScript();
756 
764  void SetScript(const WString& script);
765 
766  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
767  explicit JavaScriptAction(FS_HANDLE handle = NULL);
768 };
769 
777 class NamedAction FS_FINAL : public Action {
778  public:
784  explicit NamedAction(const Action& action);
785 
797  String GetName();
798 
812  void SetName(const String& name);
813 };
814 
838 class RemoteGotoAction FS_FINAL : public Action {
839  public:
845  explicit RemoteGotoAction(const Action& action);
846 
867 
875  void SetDestination(const Destination& destination);
876 
896 
906  void SetDestinationName(const String& dest_name);
907 
914 
924  void SetFileSpec(const FileSpec& file_specification);
925 
940 
957  void SetNewWindowFlag(NewWindowFlag flag);
958 };
959 
965 class EmbeddedGotoTarget FS_FINAL : public Base {
966  public:
974  explicit EmbeddedGotoTarget(const PDFDoc& document);
984 
990  EmbeddedGotoTarget(const EmbeddedGotoTarget& action);
991 
1007  bool operator == (const EmbeddedGotoTarget& other) const;
1015  bool operator != (const EmbeddedGotoTarget& other) const;
1016 
1023 
1031  bool IsEmpty() const;
1032 
1046 
1061  void SetRelationship(const String& relationship);
1062 
1072 
1083  void SetAttachedFileName(const WString& embed_file_name);
1084 
1095  int GetPageIndex();
1096 
1111  void SetPageIndex(int page_index);
1112 
1125 
1140  void SetFileAttachmentAnnotIndex(int annot_index);
1141 
1150 
1160  void SetTarget(const EmbeddedGotoTarget& target);
1161 
1162  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1163  explicit EmbeddedGotoTarget(FS_HANDLE handle = NULL);
1164 };
1165 
1173 class EmbeddedGotoAction FS_FINAL : public Action {
1174  public:
1180  explicit EmbeddedGotoAction(const Action& action);
1181 
1202 
1210  void SetDestination(const Destination& destination);
1211 
1231 
1241  void SetDestinationName(const String& dest_name);
1242 
1251 
1267  void SetRootFile(const FileSpec& file_specification);
1268 
1284 
1301  void SetNewWindowFlag(NewWindowFlag flag);
1302 
1310 
1319  void SetTarget(const EmbeddedGotoTarget& target);
1320 };
1321 
1329 class SubmitFormAction FS_FINAL : public Action {
1330  public:
1336  typedef enum _Flags {
1341  e_FlagExclude = 0x0001,
1363  e_FlagAsXFDF = 0x0020,
1384  e_FlagExclFKey = 0x0800,
1387  } Flags;
1388 
1394  explicit SubmitFormAction(const Action& action);
1395 
1401  String GetURL();
1402 
1410  void SetURL(const String& url);
1411 
1421 
1434  void SetFieldNames(const WStringArray& field_names);
1435 
1442  uint32 GetFlags();
1443 
1453  void SetFlags(uint32 flags);
1454 };
1455 
1463 class ResetFormAction FS_FINAL : public Action {
1464  public:
1470  explicit ResetFormAction(const Action& action);
1471 
1481 
1494  void SetFieldNames(const WStringArray& field_names);
1495 
1505  uint32 GetFlags();
1506 
1518  void SetFlags(uint32 flags);
1519 };
1520 
1528 class ImportDataAction FS_FINAL : public Action {
1529  public:
1535  explicit ImportDataAction(const Action& action);
1536 
1544 
1557  void SetFDFFileSpec(const FileSpec& file_specification);
1558 };
1559 
1567 class HideAction FS_FINAL : public Action {
1568  public:
1574  explicit HideAction(const Action& action);
1575 
1585 
1598  void SetFieldNames(const WStringArray& field_names);
1599 
1605  bool GetHideState();
1606 
1616  void SetHideState(bool is_hide);
1617 };
1618 
1626 class LaunchAction FS_FINAL : public Action {
1627  public:
1633  explicit LaunchAction(const Action& action);
1634 
1643 
1653  void SetFileSpec(const FileSpec& file_specification);
1654 
1670 
1687  void SetNewWindowFlag(NewWindowFlag flag);
1688 
1696 
1703 
1718 
1728 
1750  void SetWinLaunchParameter(const String& file_name, const String& default_directory,
1751  const String& operation, const String& app_parameter);
1752 
1753 };
1754 
1763 class RenditionAction FS_FINAL : public Action {
1764  public:
1770  typedef enum _OperationType {
1802  } OperationType;
1803 
1809  explicit RenditionAction(const Action& action);
1810 
1839  void SetOperationType(OperationType op_type);
1840 
1846  int GetRenditionCount() const;
1855  Rendition GetRendition(int index);
1870  void InsertRendition(const Rendition& rendition, int index = -1);
1878  void RemoveRendition(const Rendition& rendition);
1879 
1895  void SetScreenAnnot(const annots::Screen& screen_annot);
1896 
1922  void SetJavaScript(const WString& script);
1923 };
1924 
1934 class AdditionalAction FS_FINAL : public Base {
1935  public:
1941  typedef enum _TriggerEvent {
2086  } TriggerEvent;
2087 
2099  explicit AdditionalAction(const PDFDoc& doc, objects::PDFDictionary* pdf_dict = NULL);
2100 
2106  explicit AdditionalAction(const foxit::pdf::PDFPage& page);
2107 
2113  explicit AdditionalAction(const foxit::pdf::interform::Field& field);
2114 
2122  explicit AdditionalAction(const foxit::pdf::annots::Annot& annot);
2123 
2126 
2132  AdditionalAction(const AdditionalAction& other);
2148  bool operator == (const AdditionalAction& other) const;
2156  bool operator != (const AdditionalAction& other) const;
2164  bool IsEmpty() const;
2165 
2193  Action GetAction(TriggerEvent trigger);
2194 
2240  void SetAction(TriggerEvent trigger,const Action& action);
2241 
2272  bool RemoveAction(TriggerEvent trigger);
2273 
2279  bool RemoveAllActions();
2280 
2311  bool DoJSAction(TriggerEvent trigger);
2312 
2319 
2320  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
2321  explicit AdditionalAction(FS_HANDLE handle = NULL);
2322 };
2323 } // namespace actions
2324 } // namespace pdf
2325 } // namespace foxit
2326 
2327 #endif // FS_ACTION_H_
2328 
Definition: fs_action.h:965
bool IsEmpty() const
Check whether current object is empty or not.
uint32 GetFlags()
Get the flag value used for submission.
Fit the bounding box of page entirely within the display area when display the page.
Definition: fs_action.h:117
Flags
Enumeration for flags of submit form action.
Definition: fs_action.h:1336
void SetDestinationName(const String &dest_name)
Set the destination name.
Trigger a JavaScript action to be performed after saving a document.
Definition: fs_action.h:1971
Header file for PDF rendition related definitions and classes.
Trigger a JavaScript action to be performed before the field is formatted to display its current valu...
Definition: fs_action.h:1998
bool operator==(const Action &other) const
Equal operator.
Definition: fs_action.h:656
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not.
Type
Enumeration for action type.
Definition: fs_action.h:425
Bit 14. "F" entry of submitted FDF is an embedded file stream.
Definition: fs_action.h:1386
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not.
bool operator==(const Destination &other) const
Equal operator.
"NewWindow" flag is true.
Definition: fs_action.h:475
Definition: fs_annot.h:4357
float GetBottom() const
Get bottom position value.
Action type: movie action.
Definition: fs_action.h:443
JavaScriptAction(const Action &action)
Constructor, with parent class object.
URIAction(const Action &action)
Constructor, with parent class object.
WString GetScript()
Get JavaScript script.
Definition: fs_action.h:1528
Associate rendition to related screen annotation.
Definition: fs_action.h:1780
SubmitFormAction(const Action &action)
Constructor, with parent class object.
Destination(objects::PDFArray *dest_array)
Constructor, with a specified PDF array object.
FileSpec GetRootFile()
Get the file specification of the root file which is the root file for the target.
Pause any rendition being played in association with related screen annotation. If no rendition is be...
Definition: fs_action.h:1790
Action type: set-OCG-state action.
Definition: fs_action.h:457
EmbeddedGotoTarget GetTarget()
Get the target which specifies additional path information to the target document.
TriggerEvent
Enumeration for trigger event.
Definition: fs_action.h:1941
NamedAction(const Action &action)
Constructor, with parent class object.
void SetOperationType(OperationType op_type)
Set the operation type of current rendition action when being triggered.
int GetFileAttachmentAnnotIndex()
Get the annotation index which specifies a file attachment annotation in a specified page.
bool IsEmpty() const
Check whether current object is empty or not.
Trigger an action to be performed when the page is closed.
Definition: fs_action.h:1953
static Destination CreateFitPage(const PDFDoc &document, int page_index)
Create a destination object for zoom mode Destination::e_ZoomFitPage.
Definition: fs_action.h:1763
Type GetType()
Get action type.
void SetFieldNames(const WStringArray &field_names)
Set field name array.
void SetTrackPositionFlag(bool is_track_position)
Set the value for tracking position flag.
Bit 3. Field names and values are submitted in HTML Form format.
Definition: fs_action.h:1353
void SetFDFFileSpec(const FileSpec &file_specification)
Set a file specification of a FDF file, from which to import form data.
bool operator==(const AdditionalAction &other) const
Equal operator.
OperationType
Enumeration for operation type to perform when the rendition action is triggered.
Definition: fs_action.h:1770
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not.
objects::PDFDictionary * GetDict() const
Get the PDF dictionary of current object.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not.
int GetRenditionCount() const
Get the count of rendition objects.
Action type: remote go-to action.
Definition: fs_action.h:431
Definition: fs_rendition.h:38
void SetAttachedFileName(const WString &embed_file_name)
Set the embedded file name, which is used in "EmbeddedFile" name tree of current target file.
Definition: fs_basictypes.h:228
AdditionalAction(const PDFDoc &doc, objects::PDFDictionary *pdf_dict=0)
Constructor, from a PDF document or a PDF dictionary (if any).
RenditionAction(const Action &action)
Constructor, with parent class object.
void SetFlags(uint32 flags)
Set the flag value used for resetting.
Header file for file operation related definitions and functions.
void SetJavaScript(const WString &script)
Set the JavaScript script to be executed.
Action type: go-to-3D-view action.
Definition: fs_action.h:463
Bit 12. Submitted FDF excludes "F" entry.
Definition: fs_action.h:1384
String GetURL()
Get the URI string of the script at the Web server that will process the submission.
No "NewWindow" flag.
Definition: fs_action.h:477
WIDE STRING CLASS.
Definition: fx_string.h:1461
void SetScreenAnnot(const annots::Screen &screen_annot)
Set related screen annotation.
static Destination CreateXYZ(const PDFDoc &document, int page_index, float left, float top, float zoom_factor)
Create a destination object for zoom mode Destination::e_ZoomXYZ.
void SetFileSpec(const FileSpec &file_specification)
Set a file specification which specifies an application to be launched or a document to be opened or ...
bool GetHideState()
Get the hide state.
Bit 6. Field names and values are submitted as XFDF.
Definition: fs_action.h:1363
String GetName()
Get the name of the action.
Action type: hide action.
Definition: fs_action.h:445
bool operator !=(const Destination &other) const
Not equal operator.
String GetWinDefaultDirectory()
(Windows-specific launch parameters) Get the default directory in standard DOS syntax.
void SetFileSpec(const FileSpec &file_specification)
Set the file specification which specifies the destination file.
Bit 9. The document is submitted as PDF.
Definition: fs_action.h:1375
bool RemoveAllActions()
Remove all actions.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation receive...
Definition: fs_action.h:2045
Fit the entire width of the page's bounding box within the display area when display the page.
Definition: fs_action.h:123
Definition: fs_action.h:65
Definition: fs_pdfdoc.h:648
void SetFileAttachmentAnnotIndex(int annot_index)
Set the annotation index which specifies a file attachment annotation in a specified page.
Definition: fs_action.h:1329
void SetScript(const WString &script)
Set JavaScript script.
WStringArray GetFieldNames()
Get all field names from the array in current submit form action.
void SetTarget(const EmbeddedGotoTarget &target)
Set the target.
OperationType GetOperationType()
Get the operation type of current rendition action when being triggered.
Action GetAction(TriggerEvent trigger)
Get an action with specified trigger event type.
Trigger an action to be performed when the cursor enters the annotation's active area.
Definition: fs_action.h:2020
annots::Screen GetScreenAnnot()
Get the related screen annotation.
Trigger an action to be performed when the page containing the annotation is closed.
Definition: fs_action.h:2071
Destination & operator=(const Destination &other)
Assign operator.
Action type: embedded go-to action.
Definition: fs_action.h:433
Action type: reset-form action.
Definition: fs_action.h:451
Stop any rendition being played in association with related screen annotation and remove the associat...
Definition: fs_action.h:1785
int GetPageIndex(const PDFDoc &document) const
Get the index of the destination page.
Action type: submit-form action.
Definition: fs_action.h:449
Bit 5. Coordinates of the mouse are transmitted as part of the form data.
Definition: fs_action.h:1361
void RemoveAllSubActions()
Remove all the sub-actions.
Trigger an action to be performed when the page containing the annotation is opened.
Definition: fs_action.h:2062
String GetDestinationName()
Get the destination name which is defined in final target PDF file.
Trigger a JavaScript action to be performed when the field's value is changed.
Definition: fs_action.h:2005
Fit the entire height of the page within the display area when display the page.
Definition: fs_action.h:100
Trigger a JavaScript action to be performed before closing a document.
Definition: fs_action.h:1959
Fit the entire width of the page within the display area when display the page.
Definition: fs_action.h:93
AdditionalAction & operator=(const AdditionalAction &other)
Assign operator.
Action(const PDFDoc &document, objects::PDFDictionary *action_dict)
Constructor, with parameters.
float GetZoomFactor() const
Get zoom factor.
EmbeddedGotoTarget(const PDFDoc &document)
Constructor, with PDF document.
EmbeddedGotoTarget & operator=(const EmbeddedGotoTarget &other)
Assign operator.
bool IsTrackPosition()
Check whether to track the mouse position when the URI is resolved.
void SetName(const String &name)
Set the name of the action.
int GetSubActionCount()
Get the count of sub-actions.
bool operator !=(const EmbeddedGotoTarget &other) const
Not equal operator.
bool IsEmpty() const
Check whether current object is empty or not.
Bit 4. Field names and values are submitted using an HTTP GET request.
Definition: fs_action.h:1359
Bit 1. If set, fields name defined in submit form action should be excluded from submitting; if not s...
Definition: fs_action.h:1341
Action type: uniform resource identifier (URI) action.
Definition: fs_action.h:439
ZoomMode
Enumeration for zoom mode.
Definition: fs_action.h:72
Action type: import-data action.
Definition: fs_action.h:453
Trigger an action to be performed when the page is opened.
Definition: fs_action.h:1947
static Destination CreateFromPDFArray(const PDFDoc &document, objects::PDFArray *pdf_array)
Create a destination object from an existing destination array.
String GetWinAppOperation()
(Windows-specific launch parameters) Get the operation name.
Action & operator=(const Action &other)
Assign operator.
bool operator==(const EmbeddedGotoTarget &other) const
Equal operator.
float GetTop() const
Get top position value.
GotoAction(const Action &action)
Constructor, with parent class object.
static Destination CreateFitBHorz(const PDFDoc &document, int page_index, float top)
Create a destination object for zoom mode Destination::e_ZoomFitBHorz.
LaunchAction(const Action &action)
Constructor, with parent class object.
static Destination CreateFitBVert(const PDFDoc &document, int page_index, float left)
Create a destination object for zoom mode Destination::e_ZoomFitBVert.
String GetURI()
Get the URI string.
NewWindowFlag GetNewWindowFlag()
Get the flag which is used to decide whether to open the destination document in a new window or not.
static Destination CreateFitBBox(const PDFDoc &document, int page_index)
Create a destination object for zoom mode Destination::e_ZoomFitBBox.
bool operator !=(const AdditionalAction &other) const
Not equal operator.
Bit 2. Submit fields regardless of whether they have a value.
Definition: fs_action.h:1346
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
Trigger an action to be performed when the cursor exits the annotation's active area.
Definition: fs_action.h:2026
Trigger a JavaScript action to be performed when the user types a keystroke into a text field or comb...
Definition: fs_action.h:1991
~Destination()
Destructor.
void SetURL(const String &url)
Set the URI string of the script at the Web server that will process the submission.
void SetRootFile(const FileSpec &file_specification)
Set the file specification of the root file which is the root file for the target.
void SetHideState(bool is_hide)
Set the hide state.
Definition: fs_action.h:689
Definition: fs_pdfform.h:145
Action type: JavaScript action.
Definition: fs_action.h:455
EmbeddedGotoAction(const Action &action)
Constructor, with parent class object.
Action type: thread action.
Definition: fs_action.h:437
Definition: fs_action.h:1626
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
Fit the entire height of the page's bounding box within the display area when display the page.
Definition: fs_action.h:129
No operation is specified.
Definition: fs_action.h:1772
Definition: fs_pdfpage.h:412
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Trigger an action to be performed when the page containing the annotation is no longer visible in the...
Definition: fs_action.h:2085
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
Header file for common definitions and classes.
Action type: unknown action.
Definition: fs_action.h:427
WString GetAttachedFileName()
Get the embedded file name, which is used in "EmbeddedFile" name tree of current target file.
FileSpec GetFDFFileSpec()
Get the file specification for the FDF file, from which to import form data.
bool DoJSAction(TriggerEvent trigger)
Perform javascript action which is specified by a trigger event type.
bool IsEmpty() const
Check whether current object is empty or not.
Action type: sound action.
Definition: fs_action.h:441
FileSpec GetFileSpec()
Get the file specification which specifies the application to be launched or the document to be opene...
void SetTarget(const EmbeddedGotoTarget &target)
Set the target which specifies additional path information to the target document.
Action type: rendition action.
Definition: fs_action.h:459
Destination GetDestination()
Get the destination information.
void SetFieldNames(const WStringArray &field_names)
Set field name array.
Header file for PDF object related definitions and classes.
void SetSubAction(int index, const Action &sub_action)
Set a sub-action by index.
Definition: fs_action.h:1463
NewWindowFlag
Enumeration for new window flag.
Definition: fs_action.h:471
String GetRelationship()
Get relationship between current target object and the object that current target object belongs to.
Definition: fs_basictypes.h:443
Fit the entire page within the display area when display the page.
Definition: fs_action.h:87
Trigger an action to be performed when the page containing the annotation becomes visible in the view...
Definition: fs_action.h:2078
static Destination CreateFitHorz(const PDFDoc &document, int page_index, float top)
Create a destination object for zoom mode Destination::e_ZoomFitHorz.
Resume any rendition being played in association with related screen annotation. If no rendition is b...
Definition: fs_action.h:1795
Definition: fs_action.h:741
Definition: fs_filespec.h:38
WStringArray GetFieldNames()
Get all field names from the array of current hide action.
RemoteGotoAction(const Action &action)
Constructor, with parent class object.
Bit 10. Any submitted field values representing dates are converted to the standard format.
Definition: fs_action.h:1377
String GetWinFileName()
(Windows-specific launch parameters) Get the file name of the application to be launched or the docum...
Definition: fs_annot.h:994
WStringArray GetFieldNames()
Get all field names from the array of current reset form action.
void RemoveRendition(const Rendition &rendition)
Remove a rendition object from current rendition action.
Definition: fs_pdfobject.h:809
Trigger a JavaScript action to be performed before saving a document.
Definition: fs_action.h:1965
Definition: fs_action.h:1934
void SetFlags(uint32 flags)
Set the flag value used for submission.
void SetURI(const String &uri)
Set the URI string.
bool IsTopNull() const
Check if top value is a null object.
Foxit namespace.
Definition: fs_taggedpdf.h:27
void InsertSubAction(int index, const Action &sub_action)
Insert a new sub-action to the location specified by index.
String GetDestinationName()
Get the destination name, which is defined in target PDF file.
void SetFieldNames(const WStringArray &field_names)
Set field name array.
Definition: fs_action.h:838
static Destination CreateFitRect(const PDFDoc &document, int page_index, float left, float bottom, float right, float top)
Create a destination object for zoom mode Destination::e_ZoomFitRect.
Action type: named action.
Definition: fs_action.h:447
void SetPageIndex(int page_index)
Set the page index which specifies the page that contains the target file attachment annotation.
Definition: fs_action.h:418
Rendition GetRendition(int index)
Get a rendition by index.
(Applicable for widget annotation only) Trigger an action to be performed when the annotation loses t...
Definition: fs_action.h:2053
Trigger a JavaScript action to be performed before printing a document.
Definition: fs_action.h:1977
BYTE STRING CLASS.
Definition: fx_string.h:317
FileSpec GetFileSpec()
Get the file specification which specifies the destination file.
PDFDoc GetDocument()
Get the PDF document, to which current action belongs.
static Destination CreateFitVert(const PDFDoc &document, int page_index, float left)
Create a destination object for zoom mode Destination::e_ZoomFitVert.
Action type: transition action.
Definition: fs_action.h:461
Trigger an action to be performed when the mouse button is pressed inside the annotation's active are...
Definition: fs_action.h:2032
"NewWindow" flag is false.
Definition: fs_action.h:473
Trigger a JavaScript action to be performed to recalculate the value of this field when that of anoth...
Definition: fs_action.h:2014
HideAction(const Action &action)
Constructor, with parent class object.
Trigger an action to be performed when the mouse button is released inside the annotation's active ar...
Definition: fs_action.h:2038
Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document.
Definition: fs_action.h:1373
uint32 GetFlags()
Get the flag value used for resetting.
float GetLeft() const
Get left position value.
Trigger a JavaScript action to be performed after printing a document.
Definition: fs_action.h:1983
Display page with a specified position and a specified zoom factor.
Definition: fs_action.h:79
void SetDestination(const Destination &destination)
Set the destination information which specifies where to jump to in the final target file.
Definition: fs_action.h:777
bool IsLeftNull() const
Check if left value is a null object.
void SetRelationship(const String &relationship)
Set relationship between current target object and the object that current target object belongs to.
String GetWinAppParameter()
(Windows-specific launch parameters) Get parameter string to be passed to the specified application.
ImportDataAction(const Action &action)
Constructor, with parent class object.
void SetDestinationName(const String &dest_name)
Set the destination name.
#define NULL
The null-pointer value.
Definition: fx_system.h:792
Fit the page content in a specified rectangle entirely within the display area when display the page.
Definition: fs_action.h:109
Action GetSubAction(int index)
Get a sub-action by index.
WString GetJavaScript()
Get the JavaScript script to be executed.
Destination GetDestination()
Get the destination information which specifies where to jump to in the final target file.
bool RemoveAction(TriggerEvent trigger)
Remove an action with specified trigger event type.
void SetWinLaunchParameter(const String &file_name, const String &default_directory, const String &operation, const String &app_parameter)
(Windows-specific launch parameters)Set Windows-specific launch parameters.
void RemoveSubAction(int index)
Remove a sub-action, specified by index.
EmbeddedGotoTarget GetTarget()
Get the target.
Definition: fs_pdfobject.h:614
void InsertRendition(const Rendition &rendition, int index=-1)
Insert a rendition to current rendition action, at the position specified by index.
objects::PDFArray * GetDestArray() const
Get the destination PDF array.
void SetDestination(const Destination &dest)
Set the destination information.
bool operator !=(const Action &other) const
Not equal operator.
void SetAction(TriggerEvent trigger, const Action &action)
Set a additional-action for specified trigger event type.
void SetNewWindowFlag(NewWindowFlag flag)
Set the flag which is used to decide whether to open the destination document in a new window or not.
Definition: fs_action.h:1173
Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary.
Definition: fs_action.h:1368
Destination::ZoomMode GetZoomMode() const
Get the zoom mode.
Action type: launch action.
Definition: fs_action.h:435
int GetPageIndex()
Get the page index which specifies the page that contains the target file attachment annotation.
Play rendition (which is specified in rendition action), associating it with related screen annotatio...
Definition: fs_action.h:1801
ResetFormAction(const Action &action)
Constructor, with parent class object.
Action type: go-to action.
Definition: fs_action.h:429
Destination GetDestination()
Get the destination information.
Definition: fs_action.h:1567
Bit 11. Only those markup annotations whose "T" entry matches the name of the current user are being ...
Definition: fs_action.h:1382
void SetDestination(const Destination &destination)
Set the destination information, which is used to specify the position in target PDF file to jump to.
float GetRight() const
Get right position value.
static Action Create(const foxit::pdf::PDFDoc &document, Type action_type)
Create a new action, for specified action type.