List Option Class
This defines a list option
Definition
Namespace: Sandcastle.Core.CommandLine
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.3.29.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.3.29.0
C#
public sealed class ListOption : StringOptionVB
Public NotInheritable Class ListOption
Inherits StringOptionC++
public ref class ListOption sealed : public StringOptionF#
[<SealedAttribute>]
type ListOption =
class
inherit StringOption
end- Inheritance
- Object BaseOption StringOption ListOption
Remarks
A a list option is like a StringOption but the value is a comma-separated
list of one or more values.
Constructors
| ListOption(String, String) | Constructor |
| ListOption(String, String, String) | Constructor |
Properties
| Description |
This read-only property returns the option description
(Inherited from BaseOption) |
| IsPresent |
This read-only property is used to determine whether or not the option value was present on the
command line.
(Inherited from BaseOption) |
| Name |
This read-only property returns the option name
(Inherited from BaseOption) |
| RequiredMessage |
This is used to get or set a message to display if the option is missing
(Inherited from BaseOption) |
| Template |
This is used to specify the template used when showing the command line syntax
(Inherited from StringOption) |
| Value |
This is overridden to return the value as a string array
(Overrides BaseOptionValue) |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |