IUIX_CmdItem::Highlight Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdItem::Highlight Method}} | {{#customTitle:IUIX_CmdItem::Highlight Method}} | ||
− | {{#parentPage:PXV:IUIX_CmdItem#Methods|Highlight | + | {{#parentPage:PXV:IUIX_CmdItem#Methods|Highlight|method}} |
− | + | ||
{{ToReview}} | {{ToReview}} | ||
− | + | 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 | + | <pre class="brush:cpp;gutter:false">HRESULT Highlight([in, defaultvalue(0)] LONG nFlags, |
− | [in, defaultvalue(-1)] | + | [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 == |
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.