IUIX_CmdItem::Highlight Method

Latest revision as of 08:13, 25 March 2020

UI Layer > Interfaces > IUIX_CmdItem > IUIX_CmdItem::Highlight Method

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

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

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

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#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 ==
-<pre class="brush:cpp;gutter:false">HRESULT Highlight([in, optional] LONG nFlags, [in, optional] ULONG nDuration);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT Highlight([in, defaultvalue(0)]   LONG  nFlags,
+                  [in, defaultvalue(-1)]  LONG  nDuration);</pre>
 == Parameters ==
-;''nFlags''
+;nFlags
-:[in, optional]  Value of LONG.
+:[in, defaultvalue(0)]  Value of LONG containin the  [[PXV:UIX_CmdItemHighlightFlags|highlight flags]].
-;''nDuration''
+;nDuration
-:[in, optional]  Value of ULONG.
+:[in, defaultvalue(-1)]  Value of ULONG containing the highlighting duration period.
 == Return Value ==
@@ Line 17: / Line 21: @@
 == See Also ==
-See also [[PXV:IUIX_CmdItem|IUIX_CmdItem]].
+[[PXV:IUIX_CmdItem|IUIX_CmdItem]]