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, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft