GetRectFromCharacterIndex Method (Int32, Boolean)

TextBox.GetRectFromCharacterIndex Method (Int32, Boolean)


Returns the rectangle for the leading or trailing edge of the character at the specified index.

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

Public Function GetRectFromCharacterIndex (
	charIndex As Integer,
	trailingEdge As Boolean
) As Rect


Type: System.Int32

The zero-based character index of the character for which to retrieve the rectangle.

Type: System.Boolean

true to get the trailing edge of the character; false to get the leading edge of the character.

Return Value

Type: System.Windows.Rect

A rectangle for an edge of the character at the specified character index, or Empty if a bounding rectangle cannot be determined.

Exception Condition

charIndex is negative or is greater than the length of the content.

Because this method returns a rectangle that represents an edge of the character, the width of the rectangle is 0.

.NET Framework
Available since 3.0
Available since 4.0
Windows Phone Silverlight
Available since 7.0
Return to top
© 2015 Microsoft