UsageWriterIncludeCommandHelpInstruction Property

public bool? IncludeCommandHelpInstruction { get; set; }

Public Property IncludeCommandHelpInstruction As Boolean?
	Get
	Set

Dim instance As UsageWriter
Dim value As Boolean?

value = instance.IncludeCommandHelpInstruction
instance.IncludeCommandHelpInstruction = value

public:
property Nullable<bool> IncludeCommandHelpInstruction {
	Nullable<bool> get ();
	void set (Nullable<bool> value);
}

Property Value

If this property is , 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 , the message is shown even if not all commands meet these restrictions.

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

Reference