Interface IQcSuggestion
A suggestion that can be auto completed and displayed.
Namespace: QFSW.QC
Assembly: QFSW.QC.dll
Syntax
public interface IQcSuggestionProperties
FullSignature
The full signature of the suggestion for display purposes.
Declaration
string FullSignature { get; }Property Value
| Type | Description |
|---|---|
| String |
PrimarySignature
The primary component of the signature.
Declaration
string PrimarySignature { get; }Property Value
| Type | Description |
|---|---|
| String |
SecondarySignature
The secondary component of the signature.
Declaration
string SecondarySignature { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
GetCompletion(String)
Gets the completion value for this a prompt with this suggestion.
Declaration
string GetCompletion(string prompt)Parameters
| Type | Name | Description |
|---|---|---|
| String | prompt | The prompt to complete. |
Returns
| Type | Description |
|---|---|
| String | The completion value. |
GetCompletionTail(String)
Gets the completion tail, similar to the secondary signature, for a prompt with this suggestion.
Declaration
string GetCompletionTail(string prompt)Parameters
| Type | Name | Description |
|---|---|---|
| String | prompt | The prompt to complete the tail for. |
Returns
| Type | Description |
|---|---|
| String | The completion tail. |
GetInnerSuggestionContext(SuggestionContext)
Gets the inner suggestion context for this suggestion, allowing for further suggestions to be provided.
Declaration
SuggestionContext? GetInnerSuggestionContext(SuggestionContext context)Parameters
| Type | Name | Description |
|---|---|---|
| SuggestionContext | context | The outer suggestion context. |
Returns
| Type | Description |
|---|---|
| Nullable<SuggestionContext> | The inner suggestion context, null if none can be created. |
MatchesPrompt(String)
Determines if the provided prompt matches this suggestion
Declaration
bool MatchesPrompt(string prompt)Parameters
| Type | Name | Description |
|---|---|---|
| String | prompt | The prompt to check. |
Returns
| Type | Description |
|---|---|
| Boolean | If the prompt matches the suggestion. |