IPXV_Inst::SyncronizeCmdCustomization 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 SyncronizeCmdCustomization([in]                  IUIX_Obj*    ISource,
+
<pre class="brush:cpp;gutter:false">HRESULT SyncronizeCmdCustomization([in]                  IUIX_Obj*    pISource,
                                   [in]                  LONG          Flags,
+
                                   [in]                  LONG          nFlags,
                                   [in, defaultvalue(0)]  VARIANT_BOOL  FireEvent);</pre>
+
                                   [in, defaultvalue(0)]  VARIANT_BOOL  bFireEvent);</pre>
  
 
== Parameters ==
 
== Parameters ==
;ISource
+
;pISource
 
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] object. For example, here you may pass the UI-object of [[PXV:IPXV_MainFrame|IPXV_MainFrame]] to make the same toolbars layout/content in all other main frames.
 
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] object. For example, here you may pass the UI-object of [[PXV:IPXV_MainFrame|IPXV_MainFrame]] to make the same toolbars layout/content in all other main frames.
;Flags
+
;nFlags
:[in]  A flags that indicates about type of the toolbars customization (see [[PXV:UIX_CmdCustomizedFlags|UIX_CmdCustomizedFlags]]). Function ignores this parameter when <tt>FireEvent</tt> is set to <tt>false</tt>.
+
:[in]  A flags that indicates about type of the toolbars customization (see [[PXV:UIX_CmdCustomizedFlags|UIX_CmdCustomizedFlags]]). Function ignores this parameter when <tt>bFireEvent</tt> is set to <tt>false</tt>.
;FireEvent
+
;bFireEvent
 
:[in, defaultvalue(0)]  Specify <tt>true</tt> to send the <code>e.cmdCustomization</code> event to notify other handlers about new toolbars customization.
 
:[in, defaultvalue(0)]  Specify <tt>true</tt> to send the <code>e.cmdCustomization</code> event to notify other handlers about new toolbars customization.
  

Latest revision as of 03:58, 15 June 2015


Forces to synchronize the layout/content of all toolbars from the specified UI-container (main frame, any sub-pane etc.) to other UI-containers with the same type.

Syntax

HRESULT SyncronizeCmdCustomization([in]                   IUIX_Obj*     pISource,
                                   [in]                   LONG          nFlags,
                                   [in, defaultvalue(0)]  VARIANT_BOOL  bFireEvent);

Parameters

pISource
[in] Pointer to IUIX_Obj object. For example, here you may pass the UI-object of IPXV_MainFrame to make the same toolbars layout/content in all other main frames.
nFlags
[in] A flags that indicates about type of the toolbars customization (see UIX_CmdCustomizedFlags). Function ignores this parameter when bFireEvent is set to false.
bFireEvent
[in, defaultvalue(0)] Specify true to send the e.cmdCustomization event to notify other handlers about new toolbars customization.

Return Value

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

See Also

IPXV_Inst