ITextStoreAnchor::GetAnchorFromPoint method (textstor.h)
The ITextStoreAnchor::GetAnchorFromPoint method converts a point in screen coordinates to an anchor positioned at a corresponding location.
Syntax
HRESULT GetAnchorFromPoint(
[in] TsViewCookie vcView,
[in] const POINT *ptScreen,
[in] DWORD dwFlags,
[out] IAnchor **ppaSite
);
Parameters
[in] vcView
Specifies the context view.
[in] ptScreen
Pointer to the POINT structure with the screen coordinates of the point.
[in] dwFlags
Specifies the anchor position to return based upon the screen coordinates of the point relative to a character bounding box. By default, the anchor position returned is the character bounding box containing the screen coordinates of the point. If the point is outside a character bounding box, the method returns NULL or TF_E_INVALIDPOINT. Other bit flags for this parameter are as follows.
The bit flags can be combined.
[out] ppaSite
Pointer to an anchor object at a location corresponding to the screen coordinates ptScreen.
Return value
This method can return one of these values.
Value | Description |
---|---|
|
The method was successful. |
|
The method failed. |
|
One or more input parameters is invalid. |
|
The attempt to instantiate an anchor at the specified location failed. |
|
The ptScreen parameter is not within the bounding box of any character. |
|
The application has not calculated a text layout yet. |
Remarks
The point 1 screen coordinates cause the offset (character position) of anchor ppaSite to be 0 by default or if the dwFlags parameter is set to GXFPF_NEAREST because the point 1 screen coordinates are inside the character bounding box of character position 0. If the dwFlags parameter is set to GXFPF_ROUND_NEAREST for point 1, the anchor offset is 1 because the point 1 screen coordinates are closest to range position 1. Range position 1 is the starting range position of character position 1.For the point 2 screen coordinates, the method returns TF_E_INVALIDPOINT by default or if the dwFlags parameter is set to GXFPF_NEAREST because the point 2 screen coordinates are outside a character bounding box. If the dwFlags parameter is set to GXFPF_ROUND_NEAREST, then the point 2 screen coordinates causes the anchor offset to be 1, because the closest character position to the point 2 screen coordinates is character position 1.
Point 1
- Default-- anchor offset = 0 --The screen coordinates point is inside the character bounding box of Character Position 0.
- GXFPF_ROUND_NEAREST -- anchor offset = 1 --The screen coordinates of the point is closest to Range Position 1 which is the starting range position of Character Position 1.
- GXFPF_NEAREST -- anchor offset = 0 --The default behavior occurs because the point is within the character bounding box of Character Position 0.
- Default-- hr = TF_E_INVALIDPOINT --The screen coordinates of the point are outside a character bounding box.
- GXFPF_ROUND_NEAREST-- hr = TF_E_INVALIDPOINT --The default behavior occurs because the screen coordinates of the point is outside a character bounding box.
- GXFPF_NEAREST-- anchor offset = 1 --The closest character position to the screen coordinates of the point is Character Position 1.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional [desktop apps | UWP apps] |
Minimum supported server | Windows 2000 Server [desktop apps | UWP apps] |
Target Platform | Windows |
Header | textstor.h |
DLL | Msctf.dll |
Redistributable | TSF 1.0 on Windows 2000 Professional |