TextBox.GetCharacterIndexFromPoint Method (Point, Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the zero-based index of the character that is closest to the specified point.

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

member GetCharacterIndexFromPoint : 
        point:Point *
        snapToText:bool -> int

Parameters

point
Type: System.Windows.Point

A point in TextBox coordinate-space for which to return an index.

snapToText
Type: System.Boolean

true to return the nearest index if there is no character at the specified point; false to return –1 if there is no character at the specified point.

Return Value

Type: System.Int32

The index of the character that is closest to the specified point, or –1 if no valid index can be found.

.NET Framework
Available since 3.0
Return to top
Show: