This documentation is archived and is not being maintained.

TextPointer.GetCharacterRect Method

Returns a bounding box (Rect) for content that borders the current TextPointer in the specified logical direction.

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

public Rect GetCharacterRect(
	LogicalDirection direction


Type: System.Windows.Documents.LogicalDirection
One of the LogicalDirection values that specifies the logical direction in which to find a content bounding box.

Return Value

Type: System.Windows.Rect
A bounding box for content that borders the current TextPointer in the specified direction, or Rect.Empty if current, valid layout information is unavailable.

TextElement edges are not considered content for the purposes of this method. If the TextPointer is positioned before a TextElement edge, the return value is a bounding box for the next non-TextElement content in the specified direction. If there is no content in the specified direction, a zero-width Rect is returned with a height matching the height of any preceding content.

The operation performed by this method depends on a valid layout. When necessary, this method attempts to automatically regenerate a valid layout before proceeding with the operation. Regenerating a layout can be a relatively expensive operation. Use the HasValidLayout property to check for a valid layout before performing operations that may regenerate the layout. For more information, see Layout System.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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