TextBox::GetRectFromCharacterIndex Method (Int32, Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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
)

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.

Exception Condition
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
Available since 3.0
Silverlight
Available since 4.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: