Class CompletionData

Namespace

Loehnert.Lisrt.Scripting.Editor.File.IntelliSense

Assembly

Loehnert.Lisrt.Scripting.dll

Describes an entry in the ICSharpCode.AvalonEdit.CodeCompletion.CompletionList.

public class CompletionData : ICompletionData

Inheritance

object

CompletionData

Implements

ICompletionData

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

CompletionData(ICompletion)

Initializes a new instance of the CompletionData class.

public CompletionData(ICompletion completion)

Parameters

completion ICompletion

Completion that contains data for the new instance.

Exceptions

ArgumentNullException

Thrown when a argument is null.

Properties

CompletionText

Gets the text. This property is used to filter the list of visible elements.

public string CompletionText { get; }

Property Value

string

Content

Gets the displayed content. This can be the same as 'Text', or a WPF UIElement if you want to display rich content.

public object Content { get; }

Property Value

object

Description

Gets the description.

public object Description { get; }

Property Value

object

Image

Gets the image.

public ImageSource Image { get; }

Property Value

ImageSource

Priority

Gets the priority. This property is used in the selection logic. You can use it to prefer selecting those items which the user is accessing most frequently.

public double Priority { get; }

Property Value

double

Text

Gets the text. This property is used to filter the list of visible elements.

public string Text { get; }

Property Value

string

TypeDescription

Gets the type description (e.g. Class).

public string TypeDescription { get; }

Property Value

string

Methods

Complete(TextArea, ISegment, EventArgs)

Perform the completion.

public void Complete(TextArea textArea, ISegment completionSegment, EventArgs insertionRequestEventArgs)

Parameters

textArea TextArea

The text area on which completion is performed.

completionSegment ISegment

The text segment that was used by the completion window if the user types (segment between CompletionWindow.StartOffset and CompletionWindow.EndOffset).

insertionRequestEventArgs EventArgs

The EventArgs used for the insertion request. These can be TextCompositionEventArgs, KeyEventArgs, MouseEventArgs, depending on how the insertion was triggered.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.