WriteUsageOptionsIncludeAliasInDescription Property

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

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.3.0

Syntax

C++

Copy

public bool IncludeAliasInDescription { get; set; }

Public Property IncludeAliasInDescription As Boolean
	Get
	Set

Dim instance As WriteUsageOptions
Dim value As Boolean

value = instance.IncludeAliasInDescription

instance.IncludeAliasInDescription = value

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

Property Value

Type: Boolean
if the alias(es) should be included in the description; otherwise, .

Remarks

If this property is and an argument has one or more aliases, the aliases will be formatted using the AliasFormat property (if there's one alias) or the AliasesFormat property (for multiple aliases), and then included in the description according to the ArgumentDescriptionFormat property.

For arguments that do not have any aliases, this property has no effect.

Reference

WriteUsageOptions Class

Ookii.CommandLine Namespace

WriteUsageOptionsAddLanguageSpecificTextSet("LST16E267D7_0?cpp=::|nu=.");IncludeAliasInDescription Property

Property Value

Reference

WriteUsageOptionsIncludeAliasInDescription Property