IHitTestResult Interface

public interface IHitTestResult

TagSnapshotRange<IIntraTextSpacerTag> IntraTextSpacerTag { get; }

Property Value

TagSnapshotRange<IIntraTextSpacerTag>:

The intra-text spacer tag range that is directly under the Location, if any.

Point Location { get; }

Property Value

Point:

The Point for which the hit test result was created, relative to the SyntaxEditor.

int Offset { get; }

Property Value

int:

The zero-based offset within the Snapshot that is directly under the Location, or closest to it.

Remarks

If the Location is directly over a character, the Type property returns HitTestResultType.ViewTextAreaOverCharacter and this property indicates the offset of the character. Otherwise, the offset of the nearest character is used. For instance, locations over the line number margin will return the offset of the first character in the view line that the mouse is over.

The value will be -1 if the Location is not over an editor view.

TextPosition Position { get; }

Property Value

TextPosition:

The zero-based TextPosition within the Snapshot that is directly under the Location, or closest to it.

Remarks

If the Location is directly over a character, the Type property returns HitTestResultType.ViewTextAreaOverCharacter and this property indicates the TextPosition of the character. Otherwise, the position of the nearest character is used. For instance, locations over the line number margin will return the position of the first character in the view line that the mouse is over.

The value will be TextPosition.Empty if the Location is not over an editor view.

ITextSnapshot Snapshot { get; }

Property Value

ITextSnapshot:

The ITextSnapshot that was current within the View when the hit test was performed.

SyntaxEditor SyntaxEditor { get; }

Property Value

SyntaxEditor:

The SyntaxEditor that was hit tested.

Point TextAreaLocation { get; }

Property Value

Point:

The Location value but in Point relative to the View's text area.

Remarks

This location is useful for calls to methods like IEditorView.LocationToPosition(Point, LocationToPositionAlgorithm).

HitTestResultType Type { get; }

Property Value

HitTestResultType:

A HitTestResultType that provides a general categorization about what the hit test result represents.

IEditorView View { get; }

Property Value

IEditorView:

The IEditorView, if any, that the Location is over.

ITextViewLine ViewLine { get; }

Property Value

ITextViewLine:

The ITextViewLine that contains the Position.

Remarks

See the remarks on the Position property for details on how it is populated.

IEditorViewMargin ViewMargin { get; }

Property Value

IEditorViewMargin:

The IEditorViewMargin, if any, that the Location is over.

IUIElement VisualElement { get; }

Property Value

IUIElement:

The IUIElement, if any, that is related to the hit test result.

ITextSnapshotReader GetReader()

Returns

ITextSnapshotReader:

An ITextSnapshotReader that is initialized to the Offset.