ArgumentValidationWithHelpAttributeIncludeInUsageHelp 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: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83

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
to include it in the description; otherwise, . The default value is .

Remarks

This has no effect if the UsageWriterIncludeValidatorsInDescription property is .

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

ArgumentValidationWithHelpAttributeIncludeInUsageHelp Property

Definition

Property Value

Remarks

See Also

Reference