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 Rect GetRectFromCharacterIndex(
	int charIndex,
	bool trailingEdge
)
You cannot use methods in XAML.

Parameters

charIndex
Type: System.Int32

The zero-based character index of the character for which to retrieve the bounding 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.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5, 3.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft