CommandLineArgumentAttribute Class

public sealed class CommandLineArgumentAttribute : Attribute

Public NotInheritable Class CommandLineArgumentAttribute
	Inherits Attribute

Dim instance As CommandLineArgumentAttribute

public ref class CommandLineArgumentAttribute sealed : public Attribute

Inheritance

Object    Attribute    CommandLineArgumentAttribute

If this attribute is applied to a property, the property's type determines the argument type, and the property will be set with either the set value or the default value after parsing is complete.

If an argument was not provided on the command line, and the default value is , the property will not be set and will remain at its initial value.

If this attribute is applied to a method, that method must have one of the following signatures:

public static bool Method(ArgumentType value, CommandLineParser parser);
public static bool Method(ArgumentType value);
public static bool Method(CommandLineParser parser);
public static bool Method();
public static void Method(ArgumentType value, CommandLineParser parser);
public static void Method(ArgumentType value);
public static void Method(CommandLineParser parser);
public static void Method();

In this case, the ArgumentType type determines the type of values the argument accepts. If there is no value parameter, the argument will be a switch argument, and the method will be invoked if the switch is present, even if it was explicitly set to .

The method will be invoked as soon as the argument is parsed, before parsing the entire command line is complete. Return to cancel parsing, in which case the remaining arguments will not be parsed and the Parse(String, Int32) method returns .

Unlike using the CancelParsing or ArgumentParsed event, canceling parsing with the return value does not automatically print the usage help when using the ParseT(String, Int32, ParseOptions) method or the CommandManager class. Instead, it must be requested using by setting the HelpRequested property to .

Reference