In This Article

IndicatorQuickInfoProvider Class

Provides IntelliPrompt quick info data for indicator glyphs (from IIndicatorTag instances) in the indicator margin.

public class IndicatorQuickInfoProvider : QuickInfoProviderBase, IQuickInfoProvider, IEditorViewPointerInputEventSink, IOrderable, IKeyedObject
Inheritance:
object QuickInfoProviderBase object
Implements:
IQuickInfoProvider IEditorViewPointerInputEventSink IOrderable IKeyedObject

Constructors

IndicatorQuickInfoProvider()

Initializes a new instance of the IndicatorQuickInfoProvider class.

public IndicatorQuickInfoProvider()

Properties

ContextTypes

Gets the context Type objects that are supported by this provider, which are the list of custom types that are possibly returned by the GetContext(IHitTestResult) methods.

protected override IEnumerable<Type> ContextTypes { get; }

Property Value

IEnumerable<Type>:

The context Type objects that are supported by this provider.

Methods

GetContext(IEditorView, int)

Returns an object describing the quick info context for the specified text offset, if any.

public override object GetContext(IEditorView view, int offset)
Parameter Type Description
view IEditorView

The IEditorView in which the offset is located.

offset int

The text offset to examine.

Returns

object:

An object describing the quick info context for the specified text offset, if any. A null value indicates that no context is available.

Remarks

This method is called in response to keyboard events.

GetContext(IHitTestResult)

Returns an object describing the quick info context for the specified IHitTestResult, if any.

public override object GetContext(IHitTestResult hitTestResult)
Parameter Type Description
hitTestResult IHitTestResult

The IHitTestResult to examine.

Returns

object:

An object describing the quick info context for the specified IHitTestResult, if any. A null value indicates that no context is available.

Remarks

This method is called in response to mouse events.

The default implementation of this method calls the GetContext(IEditorView, int) overload if the hit test result indicates that the hit test was over a character.

RequestSession(IEditorView, object)

Requests that an IQuickInfoSession be opened for the specified IEditorView.

protected override bool RequestSession(IEditorView view, object context)
Parameter Type Description
view IEditorView

The IEditorView that will host the session.

context object

A context object returned by GetContext(IHitTestResult).

Returns

bool:

true if a session was opened; otherwise, false.

Inherited Members