TextBox.GetCharacterIndexFromPoint(Point, Boolean) Method

Definition

Namespace:: System.Windows.Controls

Assembly:: PresentationFramework.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.

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

public:
 int GetCharacterIndexFromPoint(System::Windows::Point point, bool snapToText);

public int GetCharacterIndexFromPoint(System.Windows.Point point, bool snapToText);

member this.GetCharacterIndexFromPoint : System.Windows.Point * bool -> int

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

Parameters

point: Point

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

snapToText: 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.

Returns

Int32

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

Applies to

Feedback

Was this page helpful?

Share via