IPXV_Inst::ExecUICmd Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::ExecUICmd Method}}
 
{{#customTitle:IPXV_Inst::ExecUICmd Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|ExecUICmd|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Executes the UI-command.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ExecUICmd([in] BSTR pCmdID, [in, defaultvalue(NULL)] IUIX_Obj* pOwner);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ExecUICmd([in]                     BSTR       sCmdID,
 +
                  [in, defaultvalue(NULL)] IUIX_Obj* pOwner);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pCmdID''
+
;sCmdID
:[in]  Value of BSTR.
+
:[in]  String unique identifier of UI-command.
;''pOwner''
+
;pOwner
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[in, defaultvalue(NULL)]  The optional pointer to [[PXV:IUIX_Obj|IUIX_Obj]] that species context of executing. For example, if you have two main frames then executing:
 +
::<code>ExecUICmd("cmd.document.printPages", NULL);</code> - will show print print dialog for active document inside active frame;
 +
::<code>ExecUICmd("cmd.document.printPages", mainFrm1.Obj);</code> - will show print print dialog for active document inside first frame;
 +
::<code>ExecUICmd("cmd.document.printPages", mainFrm2.Obj);</code> - will show print print dialog for active document inside second frame;
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_ExecUICmd2|IPXV_Inst::ExecUICmd2]]

Latest revision as of 03:56, 15 June 2015


Executes the UI-command.

Syntax

HRESULT ExecUICmd([in]                      BSTR       sCmdID,
                  [in, defaultvalue(NULL)]  IUIX_Obj*  pOwner);

Parameters

sCmdID
[in] String unique identifier of UI-command.
pOwner
[in, defaultvalue(NULL)] The optional pointer to IUIX_Obj that species context of executing. For example, if you have two main frames then executing:
ExecUICmd("cmd.document.printPages", NULL); - will show print print dialog for active document inside active frame;
ExecUICmd("cmd.document.printPages", mainFrm1.Obj); - will show print print dialog for active document inside first frame;
ExecUICmd("cmd.document.printPages", mainFrm2.Obj); - will show print print dialog for active document inside second frame;

Return Value

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

See Also

IPXV_Inst, IPXV_Inst::ExecUICmd2