IPXV_PagesLayoutManager::HitTest Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_PagesLayoutManager::HitTest Method}}
 
{{#customTitle:IPXV_PagesLayoutManager::HitTest Method}}
 +
{{#parentPage:PXV:IPXV_PagesLayoutManager#Methods|HitTest|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Returns the page and coordinates on it by specified point in the Pages View's coordinates system.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT HitTest([in] POINT* pDevPoint, [out, defaultvalue(NULL)] PXC_Point* pPagePoint, [out, retval] LONG* pPage);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT HitTest([in]                       POINT*     stDevPoint,
 +
                [out, defaultvalue(NULL)] PXC_Point* stPagePoint,
 +
                [out, retval]             LONG*       nPage);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pDevPoint''
+
;stDevPoint
:[in]  Pointer to POINT.
+
:[in]  Pointer to POINT containing the point in the Control's coordinate system.
;''pPagePoint''
+
;stPagePoint
:[out, defaultvalue(NULL)]  Pointer to [[PXV:PXC_Point|PXC_Point]].
+
:[out, defaultvalue(NULL)]  Pointer to [[PXV:PXC_Point|PXC_Point]] containing the resulting point on page.
;''pPage''
+
;nPage
:[out, retval]  Pointer to LONG.
+
:[out, retval]  Pointer to LONG containing the resulting page. Will be negative if the point is not on any of the document's pages.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_PagesLayoutManager|IPXV_PagesLayoutManager]].
+
[[PXV:IPXV_PagesLayoutManager|IPXV_PagesLayoutManager]]

Latest revision as of 23:15, 8 June 2016


Returns the page and coordinates on it by specified point in the Pages View's coordinates system.

Syntax

HRESULT HitTest([in]                       POINT*      stDevPoint,
                [out, defaultvalue(NULL)]  PXC_Point*  stPagePoint,
                [out, retval]              LONG*       nPage);

Parameters

stDevPoint
[in] Pointer to POINT containing the point in the Control's coordinate system.
stPagePoint
[out, defaultvalue(NULL)] Pointer to PXC_Point containing the resulting point on page.
nPage
[out, retval] Pointer to LONG containing the resulting page. Will be negative if the point is not on any of the document's pages.

Return Value

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

See Also

IPXV_PagesLayoutManager