ToolStripTextBox.GetCharIndexFromPosition(Point) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int GetCharIndexFromPosition(System::Drawing::Point pt);

public int GetCharIndexFromPosition (System.Drawing.Point pt);

member this.GetCharIndexFromPosition : System.Drawing.Point -> int

Public Function GetCharIndexFromPosition (pt As Point) As Integer

Parameters

pt: Point

The location to search.

Returns

Int32

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

Applies to

Deila með