GlyphRun::GetCaretCharacterHitFromDistance Method

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, 
	[OutAttribute] bool% isInside
)

Parameters

distance
Type: System::Double

Offset to use for computing the caret character hit.

isInside
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

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft