FormattedText.BuildHighlightGeometry Method (Point, Int32, Int32)

 
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 a Geometry object that represents the highlight bounding box for a specified substring of the formatted text.

Namespace:   System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

member BuildHighlightGeometry : 
        origin:Point *
        startIndex:int *
        count:int -> Geometry

Parameters

origin
Type: System.Windows.Point

The origin of the highlight region.

startIndex
Type: System.Int32

The index of the initial character the highlight bounds should be obtained for.

count
Type: System.Int32

The number of characters the highlight bounds should contain.

Return Value

Type: System.Windows.Media.Geometry

The Geometry object that represents the highlight bounding box of the formatted text substring.

The returned Geometry object contains only the bounding box of the highlighted text and does not contain any rendered text.

.NET Framework
Available since 3.0
Return to top
Show: