UsageWriterIncludeDefaultValueInDescription Property

Gets or sets a value indicating whether the default value of an argument should be included in the argument description.

Definition

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

C#

public bool IncludeDefaultValueInDescription { get; set; }

VB

Public Property IncludeDefaultValueInDescription As Boolean
	Get
	Set

Dim instance As UsageWriter
Dim value As Boolean

value = instance.IncludeDefaultValueInDescription
instance.IncludeDefaultValueInDescription = value

C++

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

Property Value

Boolean
if the default value should be included in the description; otherwise, . The default value is .

Remarks

For arguments with a default value of , this property has no effect.

To exclude the default value for a particular argument only, use the CommandLineArgumentAttributeIncludeDefaultInUsageHelp property.

UsageWriterIncludeDefaultValueInDescription Property

Definition

Property Value

Remarks

See Also

Reference