Command Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a specific action that the application performs.
public ref class Command : System::CommandLine::IdentifierSymbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>
public class Command : System.CommandLine.IdentifierSymbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>
type Command = class
inherit IdentifierSymbol
interface seq<Symbol>
interface IEnumerable
Public Class Command
Inherits IdentifierSymbol
Implements IEnumerable(Of Symbol)
- Inheritance
- Derived
- Implements
Remarks
Use the Command object for actions that correspond to a specific string (the command name). See RootCommand for simple applications that only have one action. For example, dotnet run
uses run
as the command.
Constructors
Command(String, String) |
Initializes a new instance of the Command class. |
Properties
Aliases |
Gets the set of strings that can be used on the command line to specify the symbol. (Inherited from IdentifierSymbol) |
Arguments |
Represents all of the arguments for the command. |
Children |
Gets the child symbols. |
Description |
Gets or sets the description of the symbol. (Inherited from Symbol) |
Handler |
Gets or sets the ICommandHandler for the command. The handler represents the action that will be performed when the command is invoked. |
IsHidden |
Gets or sets a value indicating whether the symbol is hidden. (Inherited from Symbol) |
Name |
Gets or sets the symbol name. (Inherited from IdentifierSymbol) |
Options |
Represents all of the options for the command, including global options that have been applied to any of the command's ancestors. |
Parents |
Gets the parent symbols. (Inherited from Symbol) |
Subcommands |
Represents all of the subcommands for the command. |
TreatUnmatchedTokensAsErrors |
Gets or sets a value that indicates whether unmatched tokens should be treated as errors. For example,
if set to |
Methods
Add(Argument) |
Adds an Argument to the command. |
Add(Command) |
Adds a subcommand to the command. |
Add(Option) |
Adds an Option to the command. |
AddAlias(String) |
Adds an alias. (Inherited from IdentifierSymbol) |
AddArgument(Argument) |
Adds an Argument to the command. |
AddCommand(Command) |
Adds a subcommand to the command. |
AddGlobalOption(Option) |
Adds a global Option to the command. |
AddOption(Option) |
Adds an Option to the command. |
AddValidator(ValidateSymbolResult<CommandResult>) |
Adds a custom validator to the command. Validators can be used to create custom validation logic. |
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
GetCompletions() |
Gets completions for the symbol. (Inherited from Symbol) |
GetCompletions(CompletionContext) |
Gets the suggested values for command line completion. |
GetEnumerator() |
Gets an enumerator that represents all of the symbols for the command. |
GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
HasAlias(String) |
Determines whether the alias has already been defined. (Inherited from IdentifierSymbol) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
ToString() |
Returns a string that represents the current object. (Inherited from Symbol) |
Explicit Interface Implementations
IEnumerable.GetEnumerator() |
Returns an enumerator that iterates through a collection. |
Extension Methods
Applies to
Athugasemdir
https://aka.ms/ContentUserFeedback.
Væntanlegt: Á árinu 2024 munum við hætta með GitHub-mál sem ábendingaleið fyrir efni og skipta því út fyrir nýtt ábendingakerfi. Frekari upplýsingar er að finna hér:Senda inn og skoða endurgjöf fyrir