public abstract class ArgumentValidationAttribute : Attribute
Public MustInherit Class ArgumentValidationAttribute
Inherits Attribute
Dim instance As ArgumentValidationAttribute
public ref class ArgumentValidationAttribute abstract : public Attribute
Argument validators are executed before or after an argument's value is set, and allow you to check whether an argument's value meets certain conditions.
If validation fails, the validator will throw a CommandLineArgumentException with the category specified in the ErrorCategory property. The CommandLineParserTParseWithErrorHandling method, the CommandLineParserParseT(String, ParseOptions) method, the generated IParserTSelfParse(ParseOptions), and the CommandManager class will automatically display the error message and usage help if validation failed.
Several built-in validators are provided, and you can derive from this class to create custom validators.
ArgumentValidationAttribute | Initializes a new instance of the ArgumentValidationAttribute class |
ErrorCategory | Gets the error category used for the CommandLineArgumentException when validation fails. |
Mode | Gets a value that indicates when validation will run. |
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute) |
Equals | Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute) |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
GetErrorMessage | Gets the error message to display if validation failed. |
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute) |
GetType | Gets the Type of the current instance. (Inherited from Object) |
GetUsageHelp | Gets the usage help message for this validator. |
IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute) |
IsSpanValid | When overridden in a derived class, determines if the argument is valid. |
IsValid | When overridden in a derived class, determines if the argument is valid. |
Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute) |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
ToString | Returns a string that represents the current object. (Inherited from Object) |
Validate | Validates the argument value, and throws an exception if validation failed. |
ValidateSpan | Validates the argument value, and throws an exception if validation failed. |