IPXV_Inst::ExecuteJS Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ExecuteJS([in]                      IPXV_Document*            pDoc,
+
<pre class="brush:cpp;gutter:false">HRESULT ExecuteJS([in]                      IPXV_Document*            Doc,
                   [in]                      LPWSTR                    sScript,
+
                   [in]                      LPWSTR                    Script,
                   [in]                      PXV_ActionTriggerClass    nClass,
+
                   [in]                      PXV_ActionTriggerClass    Class,
                   [in]                      PXV_ActionTriggerSubclass  nSubclass,
+
                   [in]                      PXV_ActionTriggerSubclass  Subclass,
                   [in]                      IUnknown*                  pActionData,
+
                   [in]                      IUnknown*                  ActionData,
                   [in, defaultvalue(NULL)]  IString*                  pResult);</pre>
+
                   [in, defaultvalue(NULL)]  IString*                  Result);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pDoc
+
;Doc
 
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] object that specifies the target document.
 
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] object that specifies the target document.
;sScript
+
;Script
 
:[in]  The unicode string that contains Java Script.
 
:[in]  The unicode string that contains Java Script.
;nClass
+
;Class
 
:[in]  Value of [[PXV:PXV_ActionTriggerClass|PXV_ActionTriggerClass]]. In most cases you may pass <tt>PAEC_External</tt> value.
 
:[in]  Value of [[PXV:PXV_ActionTriggerClass|PXV_ActionTriggerClass]]. In most cases you may pass <tt>PAEC_External</tt> value.
;nSubclass
+
;Subclass
 
:[in]  Value of [[PXV:PXV_ActionTriggerSubclass|PXV_ActionTriggerSubclass]]. In most cases you may pass <tt>PAESC_Exec</tt> value.
 
:[in]  Value of [[PXV:PXV_ActionTriggerSubclass|PXV_ActionTriggerSubclass]]. In most cases you may pass <tt>PAESC_Exec</tt> value.
;pActionData
+
;ActionData
 
:[in]  Pointer to IUnknown*. Used for special trigger class/subclass combinations. Not supported currently.
 
:[in]  Pointer to IUnknown*. Used for special trigger class/subclass combinations. Not supported currently.
;pResult
+
;Result
 
:[in, defaultvalue(NULL)]  The optional pointer to the [[PXV:IString|IString]] object. Specify it if you need any output from the script executing.
 
:[in, defaultvalue(NULL)]  The optional pointer to the [[PXV:IString|IString]] object. Specify it if you need any output from the script executing.
  

Revision as of 07:31, 12 June 2015


The method executes the specified Java Script.

Syntax

HRESULT ExecuteJS([in]                      IPXV_Document*             Doc,
                  [in]                      LPWSTR                     Script,
                  [in]                      PXV_ActionTriggerClass     Class,
                  [in]                      PXV_ActionTriggerSubclass  Subclass,
                  [in]                      IUnknown*                  ActionData,
                  [in, defaultvalue(NULL)]  IString*                   Result);

Parameters

Doc
[in] Pointer to IPXV_Document object that specifies the target document.
Script
[in] The unicode string that contains Java Script.
Class
[in] Value of PXV_ActionTriggerClass. In most cases you may pass PAEC_External value.
Subclass
[in] Value of PXV_ActionTriggerSubclass. In most cases you may pass PAESC_Exec value.
ActionData
[in] Pointer to IUnknown*. Used for special trigger class/subclass combinations. Not supported currently.
Result
[in, defaultvalue(NULL)] The optional pointer to the IString object. Specify it if you need any output from the script executing.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst, IPXV_Inst::CreateString