Class OptionSet

Inheritance
Object
Collection<Option>
KeyedCollection<String, Option>
OptionSet
Namespace: Mono.Options
Syntax
public class OptionSet : KeyedCollection<string, Option>, IList<Option>, ICollection<Option>, IEnumerable<Option>, IList, ICollection, IEnumerable

Constructors

OptionSet()

Declaration
public OptionSet()

OptionSet(Converter<String, String>)

Declaration
public OptionSet(Converter<string, string> localizer)
Parameters
Type Name Description
Converter<String, String> localizer

Properties

ArgumentSources

Declaration
public ReadOnlyCollection<ArgumentSource> ArgumentSources { get; }
Property Value
Type Description
ReadOnlyCollection<ArgumentSource>

MessageLocalizer

Declaration
public Converter<string, string> MessageLocalizer { get; }
Property Value
Type Description
Converter<String, String>

Methods

Add(ArgumentSource)

Declaration
public OptionSet Add(ArgumentSource source)
Parameters
Type Name Description
ArgumentSource source
Returns
Type Description
OptionSet

Add(Option)

Declaration
public OptionSet Add(Option option)
Parameters
Type Name Description
Option option
Returns
Type Description
OptionSet

Add(String)

Declaration
public OptionSet Add(string header)
Parameters
Type Name Description
String header
Returns
Type Description
OptionSet

Add(String, OptionAction<String, String>)

Declaration
public OptionSet Add(string prototype, OptionAction<string, string> action)
Parameters
Type Name Description
String prototype
OptionAction<String, String> action
Returns
Type Description
OptionSet

Add(String, Action<String>)

Declaration
public OptionSet Add(string prototype, Action<string> action)
Parameters
Type Name Description
String prototype
Action<String> action
Returns
Type Description
OptionSet

Add(String, String, OptionAction<String, String>)

Declaration
public OptionSet Add(string prototype, string description, OptionAction<string, string> action)
Parameters
Type Name Description
String prototype
String description
OptionAction<String, String> action
Returns
Type Description
OptionSet

Add(String, String, OptionAction<String, String>, Boolean)

Declaration
public OptionSet Add(string prototype, string description, OptionAction<string, string> action, bool hidden)
Parameters
Type Name Description
String prototype
String description
OptionAction<String, String> action
Boolean hidden
Returns
Type Description
OptionSet

Add(String, String, Action<String>)

Declaration
public OptionSet Add(string prototype, string description, Action<string> action)
Parameters
Type Name Description
String prototype
String description
Action<String> action
Returns
Type Description
OptionSet

Add(String, String, Action<String>, Boolean)

Declaration
public OptionSet Add(string prototype, string description, Action<string> action, bool hidden)
Parameters
Type Name Description
String prototype
String description
Action<String> action
Boolean hidden
Returns
Type Description
OptionSet

Add<T>(String, Action<T>)

Declaration
public OptionSet Add<T>(string prototype, Action<T> action)
Parameters
Type Name Description
String prototype
Action<T> action
Returns
Type Description
OptionSet
Type Parameters
Name Description
T

Add<T>(String, String, Action<T>)

Declaration
public OptionSet Add<T>(string prototype, string description, Action<T> action)
Parameters
Type Name Description
String prototype
String description
Action<T> action
Returns
Type Description
OptionSet
Type Parameters
Name Description
T

Add<TKey, TValue>(String, OptionAction<TKey, TValue>)

Declaration
public OptionSet Add<TKey, TValue>(string prototype, OptionAction<TKey, TValue> action)
Parameters
Type Name Description
String prototype
OptionAction<TKey, TValue> action
Returns
Type Description
OptionSet
Type Parameters
Name Description
TKey
TValue

Add<TKey, TValue>(String, String, OptionAction<TKey, TValue>)

Declaration
public OptionSet Add<TKey, TValue>(string prototype, string description, OptionAction<TKey, TValue> action)
Parameters
Type Name Description
String prototype
String description
OptionAction<TKey, TValue> action
Returns
Type Description
OptionSet
Type Parameters
Name Description
TKey
TValue

AddWithAllowedValues<T>(String, String, Action<T>, T[])

Declaration
public OptionSet AddWithAllowedValues<T>(string prototype, string description, Action<T> action, T[] allowedValues)
Parameters
Type Name Description
String prototype
String description
Action<T> action
T[] allowedValues
Returns
Type Description
OptionSet
Type Parameters
Name Description
T

AddWithAllowedValues<T>(String, String, Action<T>, T[], T)

Declaration
public OptionSet AddWithAllowedValues<T>(string prototype, string description, Action<T> action, T[] allowedValues, T defaultValue)
Parameters
Type Name Description
String prototype
String description
Action<T> action
T[] allowedValues
T defaultValue
Returns
Type Description
OptionSet
Type Parameters
Name Description
T

AddWithDefaultValue<T>(String, String, Action<T>, T)

Declaration
public OptionSet AddWithDefaultValue<T>(string prototype, string description, Action<T> action, T defaultValue)
Parameters
Type Name Description
String prototype
String description
Action<T> action
T defaultValue
Returns
Type Description
OptionSet
Type Parameters
Name Description
T

CreateOptionContext()

Declaration
protected virtual OptionContext CreateOptionContext()
Returns
Type Description
OptionContext

GetKeyForItem(Option)

Declaration
protected override string GetKeyForItem(Option item)
Parameters
Type Name Description
Option item
Returns
Type Description
String
Overrides
System.Collections.ObjectModel.KeyedCollection<System.String, Mono.Options.Option>.GetKeyForItem(Mono.Options.Option)

GetOptionParts(String, out String, out String, out String, out String)

Declaration
protected bool GetOptionParts(string argument, out string flag, out string name, out string sep, out string value)
Parameters
Type Name Description
String argument
String flag
String name
String sep
String value
Returns
Type Description
Boolean

InsertItem(Int32, Option)

Declaration
protected override void InsertItem(int index, Option item)
Parameters
Type Name Description
Int32 index
Option item
Overrides
System.Collections.ObjectModel.KeyedCollection<System.String, Mono.Options.Option>.InsertItem(System.Int32, Mono.Options.Option)

Parse(IEnumerable<String>)

Declaration
public List<string> Parse(IEnumerable<string> arguments)
Parameters
Type Name Description
IEnumerable<String> arguments
Returns
Type Description
List<String>

Parse(String, OptionContext)

Declaration
protected virtual bool Parse(string argument, OptionContext c)
Parameters
Type Name Description
String argument
OptionContext c
Returns
Type Description
Boolean

RemoveItem(Int32)

Declaration
protected override void RemoveItem(int index)
Parameters
Type Name Description
Int32 index
Overrides
System.Collections.ObjectModel.KeyedCollection<System.String, Mono.Options.Option>.RemoveItem(System.Int32)

SetItem(Int32, Option)

Declaration
protected override void SetItem(int index, Option item)
Parameters
Type Name Description
Int32 index
Option item
Overrides
System.Collections.ObjectModel.KeyedCollection<System.String, Mono.Options.Option>.SetItem(System.Int32, Mono.Options.Option)

WriteOptionDescriptions(TextWriter)

Declaration
public void WriteOptionDescriptions(TextWriter o)
Parameters
Type Name Description
TextWriter o