TextBoxBase.GetCharIndexFromPosition Method

Note: This method is new in the .NET Framework version 2.0.

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
)
public int GetCharIndexFromPosition (
	Point pt
)
public function GetCharIndexFromPosition (
	pt : Point
) : int

Parameters

pt

The location to search.

Return Value

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.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: