GlyphRun.GetCaretCharacterHitFromDistance Method (Double, Boolean)


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

Retrieves the CharacterHit value that represents the character hit of the caret of the GlyphRun.

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

public CharacterHit GetCaretCharacterHitFromDistance(
	double distance,
	out bool isInside


Type: System.Double

Offset to use for computing the caret character hit.

Type: System.Boolean

Determines whether the character hit is inside the GlyphRun.

Return Value

Type: System.Windows.Media.TextFormatting.CharacterHit

A CharacterHit value that represents the character hit that is closest to the distance value. The out parameter isInside returns true if the character hit is inside the GlyphRun; otherwise, false.

The distance value represents the offset from the leading edge of the GlyphRun.

If the hit is outside the GlyphRun, the character hit represents the closest caret character hit within the GlyphRun.

The CharacterHit structure represents information about a character hit within a GlyphRun—the index of the first character that was hit as well as information about the leading or trailing edge.

.NET Framework
Available since 3.0
Return to top