Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

IQuickInfoProvider Interface

Namespace:
ActiproSoftware.Windows.Controls.SyntaxEditor.IntelliPrompt
Assembly:
ActiproSoftware.SyntaxEditor.Wpf.dll

Provides the base requirements for an object that can handle requests for display of an IntelliPrompt quick info popup.

public interface IQuickInfoProvider : IEditorViewPointerInputEventSink, IOrderable, IKeyedObject

Remarks

Objects implementing this provider interface can be registered as a service with an ISyntaxLanguage using the RegisterService(object, object) method. Any object implementing this interface will be called as needed by the language in priority order (based on IOrderable settings).

Methods

GetContext(IEditorView, int)

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

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.

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.

RequestSession(IEditorView, object, bool)

Requests that an IQuickInfoSession be opened for the specified IEditorView.

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

The IEditorView that will host the session.
context object

A context object returned by GetContext(IHitTestResult).
canTrackPointer bool

Whether to track pointer input and allow pointer movement/hovers to possibly open another quick info session.

Returns

bool:

true if a session was opened; otherwise, false.

Inherited Members