ArgumentValidationWithHelpAttribute.IncludeInUsageHelp Property

Gets or sets a value that indicates whether this validator's help should be included in the argument's description.

Definition

Namespace: Ookii.CommandLine.Validation
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.1.1

C#
public bool IncludeInUsageHelp { get; set; }

VB
Public Property IncludeInUsageHelp As Boolean
	Get
	Set

Dim instance As ArgumentValidationWithHelpAttribute
Dim value As Boolean

value = instance.IncludeInUsageHelp
instance.IncludeInUsageHelp = value

C++
public:
property bool IncludeInUsageHelp {
	bool get ();
	void set (bool value);
}

Property Value

Boolean
true to include it in the description; otherwise, false. The default value is true.

Remarks

This has no effect if the IncludeValidatorsInDescription property is false.

The help text is the value returned by GetUsageHelp(CommandLineArgument).

ArgumentValidationWithHelpAttribute.IncludeInUsageHelp Property

Definition

Property Value

Remarks

See Also

Reference