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

PythonParameterInfoProvider Class

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

Provides IntelliPrompt parameter info data for the Python language.

public class PythonParameterInfoProvider : ParameterInfoProviderBase, IParameterInfoProvider, IOrderable, IKeyedObject, IEditorDocumentTextChangeEventSink, IEditorViewSelectionChangeEventSink
Inheritance:
object ParameterInfoProviderBase object
Implements:
IParameterInfoProvider IOrderable IKeyedObject IEditorDocumentTextChangeEventSink IEditorViewSelectionChangeEventSink

Constructors

PythonParameterInfoProvider()

Provides IntelliPrompt parameter info data for the Python language.

public PythonParameterInfoProvider()

Properties

DocstringDisplayMode

A PythonDocstringDisplayMode that indicates the docstring display mode within parameter info.

public PythonDocstringDisplayMode DocstringDisplayMode { get; set; }

Property Value

PythonDocstringDisplayMode

IncludeSourceLocation

Indicates whether to include source location information (e.g., module path) within parameter info tips.

public bool IncludeSourceLocation { get; set; }

Property Value

bool

Methods

CreateContext(IEditorView)

Creates an IPythonContext for the caret's offset in the specified IEditorView.

protected virtual IPythonContext? CreateContext(IEditorView view)
Parameter Type Description
view IEditorView

The IEditorView to examine.

Returns

IPythonContext:

An IPythonContext for the caret's offset in the specified IEditorView.

OnDocumentTextChanged(SyntaxEditor, EditorSnapshotChangedEventArgs)

Occurs after a text change occurs to an IEditorDocument that uses this language.

protected virtual void OnDocumentTextChanged(SyntaxEditor editor, EditorSnapshotChangedEventArgs e)
Parameter Type Description
editor SyntaxEditor

The SyntaxEditor whose IEditorDocument is changed.
e EditorSnapshotChangedEventArgs

The EditorSnapshotChangedEventArgs that contains the event data.

OnDocumentTextChanging(SyntaxEditor, EditorSnapshotChangingEventArgs)

Occurs before a text change occurs to an IEditorDocument that uses this language.

protected virtual void OnDocumentTextChanging(SyntaxEditor editor, EditorSnapshotChangingEventArgs e)
Parameter Type Description
editor SyntaxEditor

The SyntaxEditor whose IEditorDocument that is changing.
e EditorSnapshotChangingEventArgs

The EditorSnapshotChangingEventArgs that contains the event data.

OnSessionOpening(IParameterInfoSession)

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

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

The IParameterInfoSession about to be opened.

Returns

bool:

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

OnViewSelectionChanged(IEditorView, EditorViewSelectionEventArgs)

Occurs when the selection is changed in the specified IEditorView.

protected virtual void OnViewSelectionChanged(IEditorView view, EditorViewSelectionEventArgs e)
Parameter Type Description
view IEditorView

The IEditorView that received the event.
e EditorViewSelectionEventArgs

The EditorViewSelectionEventArgs that contains the event data.

RequestSession(IEditorView)

Requests that an IParameterInfoSession be opened for the specified IEditorView.

public override bool RequestSession(IEditorView view)
Parameter Type Description
view IEditorView

The IEditorView that will host the session.

Returns

bool:

true if a session was opened; otherwise, false.

UpdateCurrentParameter(IParameterInfoSession, IPythonContext)

Updates the current parameter in the session's signatures, based on information in the specified IPythonContext.

protected virtual bool UpdateCurrentParameter(IParameterInfoSession session, IPythonContext context)
Parameter Type Description
session IParameterInfoSession

The IParameterInfoSession to update.
context IPythonContext

The IPythonContext to examine.

Returns

bool:

true if an update was made; otherwise, false.

Inherited Members

Extension Methods