GlyphRun.GetCaretCharacterHitFromDistance(Double, Boolean) Method

Definition

Namespace:

System.Windows.Media

Assembly:

PresentationCore.dll

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

public:
 System::Windows::Media::TextFormatting::CharacterHit GetCaretCharacterHitFromDistance(double distance, [Runtime::InteropServices::Out] bool % isInside);

public System.Windows.Media.TextFormatting.CharacterHit GetCaretCharacterHitFromDistance (double distance, out bool isInside);

member this.GetCaretCharacterHitFromDistance : double * bool -> System.Windows.Media.TextFormatting.CharacterHit

Public Function GetCaretCharacterHitFromDistance (distance As Double, ByRef isInside As Boolean) As CharacterHit

Parameters

distance

Double

Offset to use for computing the caret character hit.

isInside

Boolean

Determines whether the character hit is inside the GlyphRun.

Returns

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.

Remarks

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.