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
Constructors
IndicatorQuickInfoProvider()
Provides IntelliPrompt quick info data for indicator glyphs (from IIndicatorTag instances) in the indicator margin.
public IndicatorQuickInfoProvider()
Properties
ContextTypes
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
Remarks
Base class and interface types are supported as they will match any derived classes.
Methods
GetContext(IEditorView, int)
Returns an object describing the quick info context for the specified text offset
or null if no context is available.
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
Remarks
This method is called in response to keyboard events.
GetContext(IHitTestResult)
Returns an object describing the quick info context for the specified IHitTestResult
or null if no context is available.
public override object? GetContext(IHitTestResult hitTestResult)
| Parameter | Type | Description |
|---|---|---|
| hitTestResult | IHitTestResult | The IHitTestResult to examine. |
Returns
Remarks
This method is called in response to mouse events.
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:
trueif a session was opened; otherwise,false.
Inherited Members
- QuickInfoProviderBase.RequestSession(IEditorView, object, bool)
- QuickInfoProviderBase.CanTrackPointerInput
- QuickInfoProviderBase.Key
- QuickInfoProviderBase.Orderings
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()