Documentation for the C# command-line option parsing library

UsageBuilder Members

UsageBuilder overview

Public Instance Constructors

UsageBuilder Constructor Default constructor

Public Instance Properties

DefaultOptionCategory Get or set the category to use for options when an option is missing a category
GroupOptionsByCategory Get or set to group options by their categories
Usage Get the XmlDocument containing the usage content

Public Instance Methods

AddArgument Add an argument overview to the usage
AddListItem Add a list item tag to the current list
AddOption Adds an option to the output
AddOptionsOverloaded. Add multiple options to the output
AddParagraph Add a paragraph to the usage
AddParagraphContent Add content to the current paragraph node
BeginArgument Add an argument overview to the usage
BeginArguments Begin an active "arguments" tag
BeginList Open a list tag
BeginOption Method to start adding an option to the usage.
BeginOptions Begin an active "options" tag
BeginParagraph Add a paragraph to the usage
BeginSection Begin a new section tag
EndArgument Close the active "description" tag and "argument" tags
EndArguments Close the active "arguments" tag
EndList Close the active "list" tag
EndOption Close the active "description" tag and "option" tags
EndOptions Close the active "options" tag
EndParagraph Close the active "para" tag
EndSection Close the section
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
ToHtml Convert the usage to HTML
ToString (inherited from Object) Returns a String that represents the current Object.
ToTextOverloaded. Convert the usage to Text
Transform Convenience method for transforming the XML using a custom XSLT

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

UsageBuilder Class | CommandLine.OptParse Namespace