IPXV_Inst::UpdateProps Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::UpdateProps Method}}
 
{{#customTitle:IPXV_Inst::UpdateProps Method}}
{{#parentPage:PXV:IPXV_Inst|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|UpdateProps|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Updates the content of ''Properties'' pane.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT UpdateProps([in, defaultvalue(-1)] VARIANT_BOOL bLazy, [in, defaultvalue(0)] VARIANT_BOOL bFull);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT UpdateProps([in, defaultvalue(-1)] VARIANT_BOOL bLazy,
 +
                    [in, defaultvalue(0)]   VARIANT_BOOL bFull);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''bLazy''
+
;bLazy
:[in, defaultvalue(-1)] Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]   Specify <tt>false</tt> value to make the update immediately, otherwise it will be done after a short timeout (that is recommended).
;''bFull''
+
;bFull
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Specify <tt>true</tt> value to refresh ''Properties'' pane fully, i.e to re-fill fully the list of properties, otherwise the list will remain unchanged and only property-items will be updated.
  
 
== Return Value ==
 
== Return Value ==
Line 20: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_UpdateProp|IPXV_Inst::UpdateProp]]

Latest revision as of 03:58, 15 June 2015


Updates the content of Properties pane.

Syntax

HRESULT UpdateProps([in, defaultvalue(-1)]  VARIANT_BOOL  bLazy,
                    [in, defaultvalue(0)]   VARIANT_BOOL  bFull);

Parameters

bLazy
[in, defaultvalue(-1)] Specify false value to make the update immediately, otherwise it will be done after a short timeout (that is recommended).
bFull
[in, defaultvalue(0)] Specify true value to refresh Properties pane fully, i.e to re-fill fully the list of properties, otherwise the list will remain unchanged and only property-items will be updated.

Return Value

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

See Also

IPXV_Inst, IPXV_Inst::UpdateProp