Click or drag to resize

MultiValueSeparatorAttribute Class

Specifies a separator for the values of multi-value arguments
Inheritance Hierarchy
SystemObject
  SystemAttribute
    Ookii.CommandLineMultiValueSeparatorAttribute

Namespace:  Ookii.CommandLine
Assembly:  Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.3.0
Syntax
public class MultiValueSeparatorAttribute : Attribute

The MultiValueSeparatorAttribute type exposes the following members.

Constructors
  NameDescription
Public methodMultiValueSeparatorAttribute
Initializes a new instance of the MultiValueSeparatorAttribute class.
Top
Properties
  NameDescription
Public propertySeparator
Gets the separator for the values of a multi-value argument.
Public propertyTypeId (Inherited from Attribute.)
Top
Methods
  NameDescription
Public methodEquals (Inherited from Attribute.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Attribute.)
Public methodGetType (Inherited from Object.)
Public methodIsDefaultAttribute (Inherited from Attribute.)
Public methodMatch (Inherited from Attribute.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Remarks
Note Note
If you specify a separator for a multi-value argument, it will not be possible to use the separator character in the individual argument values. There is no way to escape it.

Normally, the values for a multi-value argument can only be specified by specifying the argument multiple times, e.g. by using -Sample Value1 -Sample Value2. If you specify the MultiValueSeparatorAttribute it allows you to specify multiple values with a single argument by separating them with the specified separator. For example, if the separator is set to a comma, you can use -Sample Value1,Value2. In this example, it is no longer possible to have an argument value containing a comma.

Even if the MultiValueSeparatorAttribute is specified it is still possible to use multiple arguments to specify multiple values. For example, using a comma as the separator, -Sample Value1,Value2 -Sample Value3 will mean the argument "Sample" has three values.

See Also