MultiValueSeparatorAttribute Class |
Inheritance HierarchyNamespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.4.0
SyntaxThe MultiValueSeparatorAttribute type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MultiValueSeparatorAttribute |
Initializes a new instance of the MultiValueSeparatorAttribute class.
|
Properties| Name | Description | |
|---|---|---|
 | Separator |
Gets the separator for the values of a multi-value argument.
|
| TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
| Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks 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