SwitchOption Class

This defines a switch option

Definition

Namespace: Sandcastle.Core.CommandLine
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.3.29.0

public sealed class SwitchOption : BaseOption

Public NotInheritable Class SwitchOption
	Inherits BaseOption

public ref class SwitchOption sealed : public BaseOption

[<SealedAttribute>]
type SwitchOption = 
    class
        inherit BaseOption
    end

A switch option is one that is only represented by its name

Constructor

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)

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)