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)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::ExecuteJS Method}}
 
{{#customTitle:IPXV_Inst::ExecuteJS Method}}
{{#parentPage:PXV:IPXV_Inst|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|ExecuteJS|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method executes the specified Java Script.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ExecuteJS([in] IPXV_Document* pDoc, [in] BSTR sScript, [in] PXV_ActionTriggerClass nClass, [in] PXV_ActionTriggerSubclass nSubclass, [in] IUnknown* pActionData, [out] BSTR* pResult);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ExecuteJS([in]                     IPXV_Document*             pDoc,
 +
                  [in]                     LPWSTR                    sScript,
 +
                  [in]                     PXV_ActionTriggerClass     nClass,
 +
                  [in]                     PXV_ActionTriggerSubclass nSubclass,
 +
                  [in]                     IUnknown*                 pActionData,
 +
                  [in, defaultvalue(NULL)] IString*                   pResult);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pDoc''
+
;pDoc
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]].
+
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] object that specifies the target document.
;''sScript''
+
;sScript
:[in]  Value of BSTR.
+
:[in]  The unicode string that contains Java Script.
;''nClass''
+
;nClass
:[in]  Value of [[PXV:PXV_ActionTriggerClass|PXV_ActionTriggerClass]].
+
:[in]  Value of [[PXV:PXV_ActionTriggerClass|PXV_ActionTriggerClass]]. In most cases you may pass <tt>PAEC_External</tt> value.
;''nSubclass''
+
;nSubclass
:[in]  Value of [[PXV:PXV_ActionTriggerSubclass|PXV_ActionTriggerSubclass]].
+
:[in]  Value of [[PXV:PXV_ActionTriggerSubclass|PXV_ActionTriggerSubclass]]. In most cases you may pass <tt>PAESC_Exec</tt> value.
;''pActionData''
+
;pActionData
:[in]  Pointer to IUnknown*.
+
:[in]  Pointer to IUnknown*. Used for special trigger class/subclass combinations. Not supported currently.
;''pResult''
+
;pResult
:[outPointer to BSTR.
+
:[in, defaultvalue(NULL)The optional pointer to the [[PXV:IString|IString]] object. Specify it if you need any output from the script executing.
  
 
== Return Value ==
 
== Return Value ==
Line 28: Line 33:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_CreateString|IPXV_Inst::CreateString]]

Latest revision as of 03:56, 15 June 2015


The method executes the specified Java Script.

Syntax

HRESULT ExecuteJS([in]                      IPXV_Document*             pDoc,
                  [in]                      LPWSTR                     sScript,
                  [in]                      PXV_ActionTriggerClass     nClass,
                  [in]                      PXV_ActionTriggerSubclass  nSubclass,
                  [in]                      IUnknown*                  pActionData,
                  [in, defaultvalue(NULL)]  IString*                   pResult);

Parameters

pDoc
[in] Pointer to IPXV_Document object that specifies the target document.
sScript
[in] The unicode string that contains Java Script.
nClass
[in] Value of PXV_ActionTriggerClass. In most cases you may pass PAEC_External value.
nSubclass
[in] Value of PXV_ActionTriggerSubclass. In most cases you may pass PAESC_Exec value.
pActionData
[in] Pointer to IUnknown*. Used for special trigger class/subclass combinations. Not supported currently.
pResult
[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