CompletionItem Class
Represents an IntelliPrompt completion item.
public class CompletionItem : ICompletionItem
- Inheritance:
- object object
- Implements:
- ICompletionItem
Constructors
CompletionItem()
Initializes a new instance of the CompletionItem
class.
public CompletionItem()
CompletionItem(string, IImageSourceProvider)
Initializes a new instance of the CompletionItem
class.
public CompletionItem(string text, IImageSourceProvider imageSourceProvider)
Parameter | Type | Description |
---|---|---|
text | string | The text for the item that is displayed within a list. |
imageSourceProvider | IImageSourceProvider | An IImageSourceProvider that can provide an |
CompletionItem(string, IImageSourceProvider, IContentProvider)
Initializes a new instance of the CompletionItem
class.
public CompletionItem(string text, IImageSourceProvider imageSourceProvider, IContentProvider descriptionProvider)
Parameter | Type | Description |
---|---|---|
text | string | The text for the item that is displayed within a list. |
imageSourceProvider | IImageSourceProvider | An IImageSourceProvider that can provide an |
descriptionProvider | IContentProvider | An IContentProvider that can provide content for a popup displaying a verbose description of the item. |
CompletionItem(string, IImageSourceProvider, IContentProvider, string, string)
Initializes a new instance of the CompletionItem
class.
public CompletionItem(string text, IImageSourceProvider imageSourceProvider, IContentProvider descriptionProvider, string autoCompletePreText, string autoCompletePostText)
Parameter | Type | Description |
---|---|---|
text | string | The text for the item that is displayed within a list. |
imageSourceProvider | IImageSourceProvider | An IImageSourceProvider that can provide an |
descriptionProvider | IContentProvider | An IContentProvider that can provide content for a popup displaying a verbose description of the item. |
autoCompletePreText | string | The text that is inserted into the document after the caret when auto-complete is executed. |
autoCompletePostText | string | The text that is inserted into the document before the caret when auto-complete is executed. |
CompletionItem(string, IImageSourceProvider, IContentProvider, string, string, object)
Initializes a new instance of the CompletionItem
class.
public CompletionItem(string text, IImageSourceProvider imageSourceProvider, IContentProvider descriptionProvider, string autoCompletePreText, string autoCompletePostText, object tag)
Parameter | Type | Description |
---|---|---|
text | string | The text for the item that is displayed within a list. |
imageSourceProvider | IImageSourceProvider | An IImageSourceProvider that can provide an |
descriptionProvider | IContentProvider | An IContentProvider that can provide content for a popup displaying a verbose description of the item. |
autoCompletePreText | string | The text that is inserted into the document after the caret when auto-complete is executed. |
autoCompletePostText | string | The text that is inserted into the document before the caret when auto-complete is executed. |
tag | object | An object that contains user-defined data about the item. |
CompletionItem(string, IImageSourceProvider, object)
Initializes a new instance of the CompletionItem
class.
public CompletionItem(string text, IImageSourceProvider imageSourceProvider, object tag)
Parameter | Type | Description |
---|---|---|
text | string | The text for the item that is displayed within a list. |
imageSourceProvider | IImageSourceProvider | An IImageSourceProvider that can provide an |
tag | object | An object that contains user-defined data about the item. |
Properties
AutoCompletePostText
Gets or sets the text that is inserted into the document after the caret when auto-complete is executed.
public string AutoCompletePostText { get; set; }
Property Value
- string:
The text that is inserted into the document after the caret when auto-complete is executed.
AutoCompletePreText
Gets or sets the text that is inserted into the document before the caret when auto-complete is executed.
public string AutoCompletePreText { get; set; }
Property Value
- string:
The text that is inserted into the document before the caret when auto-complete is executed.
DescriptionProvider
Gets or sets an IContentProvider that can provide content for a popup displaying a verbose description of the item.
public IContentProvider DescriptionProvider { get; set; }
Property Value
- IContentProvider:
An IContentProvider that can provide content for a popup displaying a verbose description of the item.
ImageSourceProvider
Gets or sets an IImageSourceProvider that can provide an ImageSource
for display within a list.
public IImageSourceProvider ImageSourceProvider { get; set; }
Property Value
- IImageSourceProvider:
An IImageSourceProvider that can provide an
ImageSource
for display within a list.
InlineDescription
Gets or sets an optional inline description that is displayed next to the item's Text within a list.
public string InlineDescription { get; set; }
Property Value
Tag
Gets or sets the object that contains user-defined data about the object.
public object Tag { get; set; }
Property Value
Remarks
Any type derived from the object class can be assigned to this property.
Text
Gets or sets the text for the item that is displayed within a list.
public string Text { get; set; }
Property Value
- string:
The text for the item that is displayed within a list.