ValidateNotWhiteSpaceAttribute Class

Validates that the value of an argument is not an empty string, or a string containing only white-space characters.

Definition

Namespace: Ookii.CommandLine.Validation
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public class ValidateNotWhiteSpaceAttribute : ArgumentValidationWithHelpAttribute
Inheritance
Object    Attribute    ArgumentValidationAttribute    ArgumentValidationWithHelpAttribute    ValidateNotWhiteSpaceAttribute

Remarks

  Note

This validator uses the raw string value provided by the user, before type conversion takes place.

If the argument is optional, validation is only performed if the argument is specified, so the value may still be an empty or white-space-only string if the argument is not supplied, if that is the default value.

Constructors

ValidateNotWhiteSpaceAttributeInitializes a new instance of the ValidateNotWhiteSpaceAttribute 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.
(Inherited from ArgumentValidationWithHelpAttribute)
Mode Gets a value that indicates when validation will run.
(Overrides ArgumentValidationAttributeMode)
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)

Methods

EqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
FinalizeAllows 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.
(Overrides ArgumentValidationAttributeGetErrorMessage(CommandLineArgument, Object))
GetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
GetTypeGets the Type of the current instance.
(Inherited from Object)
GetUsageHelp Gets the usage help message for this validator.
(Inherited from ArgumentValidationWithHelpAttribute)
GetUsageHelpCore Gets the usage help message for this validator.
(Overrides ArgumentValidationWithHelpAttributeGetUsageHelpCore(CommandLineArgument))
IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
IsSpanValid Determines if the argument's value is not an empty string, or contains only white-space characters.
(Overrides ArgumentValidationAttributeIsSpanValid(CommandLineArgument, ReadOnlySpanChar))
IsValid Determines if the argument's value is not an empty string, or contains only white-space characters.
(Overrides ArgumentValidationAttributeIsValid(CommandLineArgument, Object))
MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns 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.

See Also