UsageWriterIncludeCommandHelpInstruction Property

public TriState IncludeCommandHelpInstruction { get; set; }

Public Property IncludeCommandHelpInstruction As TriState
	Get
	Set

Dim instance As UsageWriter
Dim value As TriState

value = instance.IncludeCommandHelpInstruction
instance.IncludeCommandHelpInstruction = value

public:
property TriState IncludeCommandHelpInstruction {
	TriState get ();
	void set (TriState value);
}

Property Value

If this property is TriStateAuto, the instruction will be shown under the following conditions:

• The ParseOptionsAutoHelpArgument property is or .
• For every command with a ParseOptionsAttribute attribute, the ParseOptionsAttributeAutoHelpArgument property is .
• No command uses the ICommandWithCustomParsing interface (this includes commands that derive from the ParentCommand class).
• No command specifies custom values for the ParseOptionsAttributeArgumentNamePrefixes and ParseOptionsAttributeLongArgumentNamePrefix properties.
• Every command uses the same values for the ParseOptionsAttributeArgumentNameTransform and ParseOptionsAttributeMode properties.

If set to TriStateTrue, the message is shown even if not all commands meet these conditions. You can use this to show the message when you know it's valid despite this (e.g. you have a command using ICommandWithCustomParsing which implements its own help argument that matches the other commands).

To customize the message, override the WriteCommandHelpInstruction(String, String, String) method.

Reference