TextBoxBase.GetCharIndexFromPosition(Point) TextBoxBase.GetCharIndexFromPosition(Point) TextBoxBase.GetCharIndexFromPosition(Point) TextBoxBase.GetCharIndexFromPosition(Point) Method

Definition

Retrieves the index of the character nearest to the specified location.

public:
 virtual int GetCharIndexFromPosition(System::Drawing::Point pt);
public virtual int GetCharIndexFromPosition (System.Drawing.Point pt);
abstract member GetCharIndexFromPosition : System.Drawing.Point -> int
override this.GetCharIndexFromPosition : System.Drawing.Point -> int
Public Overridable Function GetCharIndexFromPosition (pt As Point) As Integer

Parameters

pt
Point Point Point Point

The location to search.

Returns

The zero-based character index at the specified location.

Remarks

This method returns the character index that is closest to the position specified in the pt parameter. The character index is a zero-based index of text in the control, including spaces. You can use this method to determine where in the text the user has the mouse over by passing the mouse coordinates to this method. This can be useful if you want to perform tasks when the user rests the mouse pointer over a word in the text of the control.

Important

If the specified location is not within the client rectangle of the control, or is beyond the last character in the control, the return value is the index of the last character.

Applies to

See also