IPXC_PageText::HitTest Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_PageText::HitTest Method}} | {{#customTitle:IPXC_PageText::HitTest Method}} | ||
| + | {{#parentPage:PXV:IPXC_PageText#Methods|HitTest|method}} | ||
| + | {{ToReview}} | ||
| − | + | Gets line index by the given point on page. Will return -1 when no lines are in the point's area. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT HitTest([in] PXC_PointF* | + | <pre class="brush:cpp;gutter:false">HRESULT HitTest([in] PXC_PointF* stPosOnPage, |
| + | [in] float nHitLineDelta, | ||
| + | [in] VARIANT_BOOL bGetNearestIfFail, | ||
| + | [out] LONG* nLineIndex);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;stPosOnPage |
| − | :[in] Pointer to [[PXV:PXC_PointF|PXC_PointF]]. | + | :[in] Pointer to [[PXV:PXC_PointF|PXC_PointF]] containing the point on page that needs to be checked. |
| − | ; | + | ;nHitLineDelta |
| − | :[in] Value of float. | + | :[in] Value of float containing the delta value. When specified, it will check the area near the point that exeeds to the given delta value. |
| − | ; | + | ;bGetNearestIfFail |
| − | : Value of VARIANT_BOOL. | + | :[in] Value of VARIANT_BOOL representing whether the nearest line should be searched for if none are in the point area. |
| − | ; | + | ;nLineIndex |
| − | :[out] Pointer to LONG. | + | :[out] Pointer to LONG containing the resulting line index. |
== Return Value == | == Return Value == | ||
| Line 21: | Line 27: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_PageText|IPXC_PageText]] | |
Latest revision as of 00:48, 23 July 2018
Gets line index by the given point on page. Will return -1 when no lines are in the point's area.
Syntax
HRESULT HitTest([in] PXC_PointF* stPosOnPage,
[in] float nHitLineDelta,
[in] VARIANT_BOOL bGetNearestIfFail,
[out] LONG* nLineIndex);
Parameters
- stPosOnPage
- [in] Pointer to PXC_PointF containing the point on page that needs to be checked.
- nHitLineDelta
- [in] Value of float containing the delta value. When specified, it will check the area near the point that exeeds to the given delta value.
- bGetNearestIfFail
- [in] Value of VARIANT_BOOL representing whether the nearest line should be searched for if none are in the point area.
- nLineIndex
- [out] Pointer to LONG containing the resulting line index.
Return Value
Returns S_OK if operation was successful or error code in other cases.
