This documentation is archived and is not being maintained.

TextBoxBase.GetCharIndexFromPosition Method

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public virtual int GetCharIndexFromPosition(
	Point pt
)

Parameters

pt
Type: System.Drawing.Point

The location to search.

Return Value

Type: System.Int32
The zero-based character index at the specified location.

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 noteImportant Note:

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: