IUIX_List::HitTest Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_List::HitTest Method}}
 
{{#customTitle:IUIX_List::HitTest Method}}
{{#parentPage:PXV:IUIX_List|HitTest Method|method}}
+
{{#parentPage:PXV:IUIX_List#Methods|HitTest|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets the list item by the given point.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT HitTest([in]  POINT*  pPos,
+
<pre class="brush:cpp;gutter:false">HRESULT HitTest([in]  POINT*  stPos,
                 [out]  LONG*  pItem,
+
                 [out]  LONG*  nItem,
                 [out]  LONG*  pColumn,
+
                 [out]  LONG*  nColumn,
                 [out]  LONG*  pGroup,
+
                 [out]  LONG*  nGroup,
                 [out]  LONG*  pItemHT);</pre>
+
                 [out]  LONG*  nItemHT);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pPos
+
;stPos
:[in]  Pointer to POINT.
+
:[in]  Pointer to POINT containing the position that needs to be checked.
;pItem
+
;nItem
:[out]  Pointer to LONG.
+
:[out]  Pointer to LONG containing the resulting item index.  
;pColumn
+
;nColumn
:[out]  Pointer to LONG.
+
:[out]  Pointer to LONG containing the column that item belongs to.
;pGroup
+
;nGroup
:[out]  Pointer to LONG.
+
:[out]  Pointer to LONG containing the group that item belongs to.
;pItemHT
+
;nItemHT
:[out]  Pointer to LONG.
+
:[out]  Pointer to LONG containing the [[PXV:UIX_ListItemHTFlags|list item HT flags]].
  
 
== Return Value ==
 
== Return Value ==
Line 30: Line 30:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_List|IUIX_List]].
+
[[PXV:IUIX_List|IUIX_List]]

Latest revision as of 07:41, 28 June 2016


Gets the list item by the given point.

Syntax

HRESULT HitTest([in]   POINT*  stPos,
                [out]  LONG*   nItem,
                [out]  LONG*   nColumn,
                [out]  LONG*   nGroup,
                [out]  LONG*   nItemHT);

Parameters

stPos
[in] Pointer to POINT containing the position that needs to be checked.
nItem
[out] Pointer to LONG containing the resulting item index.
nColumn
[out] Pointer to LONG containing the column that item belongs to.
nGroup
[out] Pointer to LONG containing the group that item belongs to.
nItemHT
[out] Pointer to LONG containing the list item HT flags.

Return Value

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

See Also

IUIX_List