ValueDescriptionAttribute Class

public class ValueDescriptionAttribute : Attribute

Public Class ValueDescriptionAttribute
	Inherits Attribute

Dim instance As ValueDescriptionAttribute

public ref class ValueDescriptionAttribute : public Attribute

Inheritance

Object    Attribute    ValueDescriptionAttribute

The value description is a short, typically one-word description that indicates the type of value that the user should supply.

The value description is used when generating usage help. For example, the usage for an argument named Sample with a value description of String would look like "-Sample <String>".

You can apply this attribute to a property or method defining an argument to set the value description for that argument. You can also apply it to a type to set a default value description for that type.

If this attribute is not present, the name of the type of the argument is used by default, applying the name transformation specified by the ParseOptionsValueDescriptionTransform property or the ParseOptionsAttributeValueDescriptionTransform property.

If a custom value description is set using this attribute, the name transformation is not applied unless the ApplyTransform property is .

If you want to override the value description for all arguments of a specific type, and you cannot apply the ValueDescriptionAttribute to this type, you can use the ParseOptionsDefaultValueDescriptions property.

You can derive from this attribute to use an alternative source for the value description, such as a resource table that can be localized.

Reference