Export (0) Print
Expand All

TextBox.GetCharacterIndexFromPoint Method

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

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

'Declaration
Public Function GetCharacterIndexFromPoint ( _
	point As Point, _
	snapToText As Boolean _
) As Integer

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

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft