ToolStripTextBox.GetCharIndexFromPosition Method (Point)

 

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 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 mouse pointer hovers over a word in the text of the control.

.NET Framework
Available since 2.0
Return to top
Show: