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)

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

Parameters

charIndex
Type: System.Int32

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

trailingEdge
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.

ExceptionCondition
ArgumentOutOfRangeException

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

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft