Modifier

Partager via


GlyphRun.GetDistanceFromCaretCharacterHit(CharacterHit) Method

Definition

Retrieves the offset from the leading edge of the GlyphRun to the leading or trailing edge of a caret stop containing the specified character hit.

public:
 double GetDistanceFromCaretCharacterHit(System::Windows::Media::TextFormatting::CharacterHit characterHit);
public double GetDistanceFromCaretCharacterHit (System.Windows.Media.TextFormatting.CharacterHit characterHit);
member this.GetDistanceFromCaretCharacterHit : System.Windows.Media.TextFormatting.CharacterHit -> double
Public Function GetDistanceFromCaretCharacterHit (characterHit As CharacterHit) As Double

Parameters

characterHit
CharacterHit

The CharacterHit to use for computing the offset.

Returns

A Double that represents the offset from the leading edge of the GlyphRun to the leading or trailing edge of a caret stop containing the character hit.

Exceptions

The character hit is outside the range specified by the GlyphRun Unicode string.

Remarks

If the GlyphRun is not hit testable, the distance of 0.0 is returned. Use the IsHitTestable property to determine if a GlyphRun can be hit test.

Applies to