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

CSharpQuickInfoProvider Class

Namespace:
ActiproSoftware.Text.Languages.CSharp.Implementation
Assembly:
ActiproSoftware.SyntaxEditor.Addons.DotNet.WinForms.dll

Provides IntelliPrompt quick info data for the C# language.

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

Constructors

CSharpQuickInfoProvider()

Initializes a new instance of the CSharpQuickInfoProvider class.

public CSharpQuickInfoProvider()

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.

OnSessionOpening(IQuickInfoSession)

Allows an inheritor to modify, filter and sort automatically-generated items before the specified IQuickInfoSession is opened and displayed to the end user. The session may also be cancelled.

protected virtual bool OnSessionOpening(IQuickInfoSession session)
Parameter Type Description
session IQuickInfoSession

The IQuickInfoSession about to be opened.

Returns

bool:

true if the session is allowed to open; otherwise, false.

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(IEditorView, int).

Returns

bool:

true if a session was opened; otherwise, false.

Inherited Members