Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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
)

Parameters

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.

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.