ListOption Class

This defines a list option

Definition

Namespace: Sandcastle.Core.CommandLine
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
public sealed class ListOption : StringOption
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

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

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also