Boolean Option Class
This defines a Boolean 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 BooleanOption : BaseOptionVB
Public NotInheritable Class BooleanOption
Inherits BaseOptionC++
public ref class BooleanOption sealed : public BaseOptionF#
[<SealedAttribute>]
type BooleanOption =
class
inherit BaseOption
end- Inheritance
- Object BaseOption BooleanOption
Remarks
A Boolean option is one that has a name followed by a '+' for true or a '-' for false
Constructors
| BooleanOption | 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) |
| Value |
This property is used to get or set the option value
(Inherited from BaseOption) |
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) |