RichTextBox.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)

'Declaration
Public Overrides Function GetCharIndexFromPosition ( _
	pt As Point _
) As Integer

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.

The following code example demonstrates how to use the GetCharIndexFromPosition method with the Find method to search for a specific string within a RichTextBox control and display the character index where the found string is located within the RichTextBox control. The example searches for the word "brown" within the contents of the control and returns the character index position where the search string is found. This example requires that you have a form that contains a RichTextBox control named richTextBox1 that contains text. It also requires that the code in the example is connected to the MouseDown event of the RichTextBox.

Private Sub richTextBox1_MouseDown(ByVal sender As Object, ByVal e As System.Windows.Forms.MouseEventArgs) Handles richTextBox1.MouseDown
    ' Declare the string to search for in the control. 
    Dim searchString As String = "brown" 

    ' Determine whether the user clicks the left mouse button and whether it is a double click. 
    If e.Clicks = 1 And e.Button = MouseButtons.Left Then 
        ' Obtain the character index where the user clicks on the control. 
        Dim positionToSearch As Integer = richTextBox1.GetCharIndexFromPosition(New Point(e.X, e.Y))
        ' Search for the search string text within the control from the point the user clicked. 
        Dim textLocation As Integer = richTextBox1.Find(searchString, positionToSearch, RichTextBoxFinds.None)

        ' If the search string is found (value greater than -1), display the index the string was found at. 
        If textLocation >= 0 Then
            MessageBox.Show(("The search string was found at character index " + textLocation.ToString() + "."))
            ' Display a message box alerting the user that the text was not found. 
        Else
            MessageBox.Show("The search string was not found within the text of the control.")
        End If 
    End If 
End Sub

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft