IPXC_PageText::HitTest Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_PageText::HitTest Method}} | {{#customTitle:IPXC_PageText::HitTest Method}} | ||
{{#parentPage:PXV:IPXC_PageText#Methods|HitTest|method}} | {{#parentPage:PXV:IPXC_PageText#Methods|HitTest|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Gets line index by the given point on page. Will return -1 when no lines are in point's range. | |
== Syntax == | == Syntax == | ||
| Line 16: | Line 15: | ||
== Parameters == | == Parameters == | ||
;stPosOnPage | ;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 | ;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 | ;bGetNearestIfFail | ||
| − | : Value of VARIANT_BOOL. | + | : Value of VARIANT_BOOL representing whether the nearest line should be searched for if none are in the point area. |
;nLineIndex | ;nLineIndex | ||
| − | :[out] Pointer to LONG. | + | :[out] Pointer to LONG containing the resulting line index. |
== Return Value == | == Return Value == | ||
Revision as of 00:09, 13 May 2016
Gets line index by the given point on page. Will return -1 when no lines are in point's range.
Syntax
HRESULT HitTest([in] PXC_PointF* stPosOnPage,
[in] float nHitLineDelta,
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
- 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.
