StringOption Class

This defines a string option

Definition

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

public class StringOption : BaseOption

Public Class StringOption
	Inherits BaseOption

public ref class StringOption : public BaseOption

type StringOption = 
    class
        inherit BaseOption
    end

A string option is one that has a name/value pair separated by a colon

StringOption(String, String)	Constructor
StringOption(String, String, String)	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)
Template	This is used to specify the template used when showing the command line syntax
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)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
ToString	Returns a string that represents the current object. (Inherited from Object)