ArgumentValidationWithHelpAttribute Class

Base class for argument validators that have usage help.

Definition

Namespace: Ookii.CommandLine.Validation
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086

C#

public abstract class ArgumentValidationWithHelpAttribute : ArgumentValidationAttribute

VB

Public MustInherit Class ArgumentValidationWithHelpAttribute
	Inherits ArgumentValidationAttribute

Dim instance As ArgumentValidationWithHelpAttribute

C++

public ref class ArgumentValidationWithHelpAttribute abstract : public ArgumentValidationAttribute

Inheritance: Object Attribute ArgumentValidationAttribute ArgumentValidationWithHelpAttribute

Derived: Ookii.CommandLine.ValidationDependencyValidationAttribute
Ookii.CommandLine.ValidationValidateCountAttribute
Ookii.CommandLine.ValidationValidateEnumValueAttribute
Ookii.CommandLine.ValidationValidateNotEmptyAttribute
Ookii.CommandLine.ValidationValidateNotWhiteSpaceAttribute
Ookii.CommandLine.ValidationValidateRangeAttribute
Ookii.CommandLine.ValidationValidateStringLengthAttribute
More Less

Remarks

It's not required for argument validators that have help to derive from this class; it's sufficient to derive from the ArgumentValidationAttribute class directly and override the ArgumentValidationAttributeGetUsageHelp(CommandLineArgument) method. This class just adds some common functionality to make it easier.

Constructors

ArgumentValidationWithHelpAttribute

Initializes a new instance of the ArgumentValidationWithHelpAttribute class

Properties

ErrorCategory	Gets the error category used for the CommandLineArgumentException when validation fails. (Inherited from ArgumentValidationAttribute)
IncludeInUsageHelp	Gets or sets a value that indicates whether this validator's help should be included in the argument's description.
Mode	Gets a value that indicates when validation will run. (Inherited from ArgumentValidationAttribute)
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

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. (Inherited from ArgumentValidationAttribute)
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. (Overrides ArgumentValidationAttributeGetUsageHelp(CommandLineArgument))
GetUsageHelpCore	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. (Inherited from ArgumentValidationAttribute)
IsValid	When overridden in a derived class, determines if the argument is valid. (Inherited from ArgumentValidationAttribute)
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. (Inherited from ArgumentValidationAttribute)
ValidateSpan	Validates the argument value, and throws an exception if validation failed. (Inherited from ArgumentValidationAttribute)

Thread Safety

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