CommandLineArgumentAttributeIncludeDefaultInUsageHelp Property

Gets or sets a value that indicates whether the argument's default value should be shown in the usage help.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83

C#

public bool IncludeDefaultInUsageHelp { get; set; }

VB

Public Property IncludeDefaultInUsageHelp As Boolean
	Get
	Set

Dim instance As CommandLineArgumentAttribute
Dim value As Boolean

value = instance.IncludeDefaultInUsageHelp
instance.IncludeDefaultInUsageHelp = value

C++

public:
property bool IncludeDefaultInUsageHelp {
	bool get ();
	void set (bool value);
}

Property Value

Boolean
to show the default value in the usage help; otherwise, . The default value is .

Remarks

The default value can be set using the DefaultValue property, or, when using source generation with the GeneratedParserAttribute attribute, using a property initializer.

This property is ignored if the UsageWriterIncludeDefaultValueInDescription property is .

CommandLineArgumentAttributeIncludeDefaultInUsageHelp Property

Definition

Property Value

Remarks

See Also

Reference