CommandInfo Class

Provides information about a subcommand.

Definition

Namespace: Ookii.CommandLine.Commands
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public abstract class CommandInfo
Inheritance
Object    CommandInfo
Derived

Constructors

CommandInfo Initializes a new instance of the CommandInfo class.

Properties

Aliases Gets the alternative names of this command.
CommandType Gets the type that implements the command.
Description Gets the description of the command.
IsHidden Gets or sets a value that indicates whether the command is hidden from the usage help.
Manager Gets the CommandManager that this instance belongs to.
Name Gets the name of the command.
ParentCommandType Gets the type of the command that is the parent of this command.
UseCustomArgumentParsing Gets a value that indicates if the command uses custom parsing.

Methods

Create Creates an instance of the CommandInfo class for the specified command type.
CreateInstance Creates an instance of the command type parsing the specified arguments.
CreateInstanceWithCustomParsing Creates an instance of a command that uses the ICommandWithCustomParsing interface.
CreateInstanceWithResult Creates an instance of the command type by parsing the specified arguments, and returns it in addition to the result of the parsing operation.
CreateParser Creates a CommandLineParser instance for the type indicated by the CommandType property.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsCommand Returns a value indicating if the specified type is a subcommand.
MatchesName Checks whether the command's name or aliases match the specified name.
MatchesPrefix Checks whether the command's name or one of its aliases start with the specified prefix.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
TryCreate Creates an instance of the CommandInfo class only if commandType represents a command type.

Thread Safety

Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.

See Also