Edit

Share via


SuggestDirective Class

Definition

Enables the use of the [suggest] directive which when specified in command line input short circuits normal command handling and writes a newline-delimited list of suggestions suitable for use by most shells to provide command line completions.

public ref class SuggestDirective sealed : System::CommandLine::Directive
public sealed class SuggestDirective : System.CommandLine.Directive
type SuggestDirective = class
    inherit Directive
Public NotInheritable Class SuggestDirective
Inherits Directive
Inheritance
SuggestDirective

Remarks

The dotnet-suggest tool requires the suggest directive to be enabled for an application to provide completions.

Constructors

SuggestDirective()

Initializes a new instance of the Object class.

Properties

Action

Gets or sets the CommandLineAction for the Directive. The handler represents the action that will be performed when the Directive is invoked.

Description

Gets or sets the description of the symbol.

(Inherited from Symbol)
Hidden

Gets or sets a value indicating whether the symbol is hidden.

(Inherited from Symbol)
Name

Gets the name of the symbol.

(Inherited from Symbol)
Parents

Gets the parent symbols.

(Inherited from Symbol)

Methods

GetCompletions(CompletionContext)

Gets completions for the symbol.

(Inherited from Directive)
ToString()

Returns a string that represents the current object.

(Inherited from Symbol)

Applies to