ValidatePatternAttribute Class

Validates that an argument's value matches the specified regular expression.

Definition

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

Remarks

  Note

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

This validator does not add any help text to the argument description.

Constructors

ValidatePatternAttribute Initializes a new instance of the ValidatePatternAttribute class.

Properties

ErrorCategory Gets the error category used for the CommandLineArgumentException when validation fails.
(Inherited from ArgumentValidationAttribute)
ErrorMessage Gets or sets a custom error message to use.
Mode Gets a value that indicates when validation will run.
(Overrides ArgumentValidationAttributeMode)
Pattern Gets the regular expression that values must match.
PatternValue Gets the regular expression string stored in this attribute.
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 ArgumentValidationAttribute)
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 matches the pattern.
(Overrides ArgumentValidationAttributeIsSpanValid(CommandLineArgument, ReadOnlySpanChar))
IsValid Determines if the argument's value matches the pattern.
(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