IUIX_CmdItem::Highlight Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdItem::Highlight Method}}
 
{{#customTitle:IUIX_CmdItem::Highlight Method}}
 +
{{#parentPage:PXV:IUIX_CmdItem#Methods|Highlight|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Highlights the command item using one of the [[PXV:UIX_CmdItemHighlightFlags|flags]] for given period.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Highlight([in, defaultvalue(0)] LONG nFlags, [in, defaultvalue(-1)] ULONG nDuration);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Highlight([in, defaultvalue(0)]   LONG nFlags,
 +
                  [in, defaultvalue(-1)] LONG  nDuration);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nFlags''
+
;nFlags
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Value of LONG containin the  [[PXV:UIX_CmdItemHighlightFlags|highlight flags]].
;''nDuration''
+
;nDuration
:[in, defaultvalue(-1)]  Value of ULONG.
+
:[in, defaultvalue(-1)]  Value of ULONG containing the highlighting duration period.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdItem|IUIX_CmdItem]].
+
[[PXV:IUIX_CmdItem|IUIX_CmdItem]]

Latest revision as of 07:13, 25 March 2020


Highlights the command item using one of the flags for given period.

Syntax

HRESULT Highlight([in, defaultvalue(0)]   LONG  nFlags,
                  [in, defaultvalue(-1)]  LONG  nDuration);

Parameters

nFlags
[in, defaultvalue(0)] Value of LONG containin the highlight flags.
nDuration
[in, defaultvalue(-1)] Value of ULONG containing the highlighting duration period.

Return Value

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

See Also

IUIX_CmdItem