Foxit PDF SDK
foxit::pdf::actions::JavaScriptAction Class Reference
Inheritance diagram for foxit::pdf::actions::JavaScriptAction:
foxit::pdf::actions::Action foxit::Base

Public Member Functions

 JavaScriptAction (const Action &action)
 Constructor, with parent class object. More...
 
WString GetScript ()
 Get JavaScript script. More...
 
void SetScript (const WString &script)
 Set JavaScript script. 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::PDFDictionaryGetDict () 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...
 
Actionoperator= (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

JavaScript action is an action that causes a script to be compiled and executed by the JavaScript interpreter.
Class actions::JavaScriptAction is derived from Action and offers functions to get/set JavaScript action data.

See also
Action

Constructor & Destructor Documentation

◆ JavaScriptAction()

foxit::pdf::actions::JavaScriptAction::JavaScriptAction ( const Action action)
explicit

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Member Function Documentation

◆ GetScript()

WString foxit::pdf::actions::JavaScriptAction::GetScript ( )

Get JavaScript script.

Returns
JavaScript script.

◆ SetScript()

void foxit::pdf::actions::JavaScriptAction::SetScript ( const WString script)

Set JavaScript script.

Parameters
[in]scriptA JavaScript script to be set. It should not be an empty string.
Returns
None.