Sandcastle Help File Builder Documentation
OptionCollection Class
This collection is used to hold a set of command line option definitions
Definition
Namespace: Sandcastle.Core.CommandLine
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0
C#
public sealed class OptionCollection : Collection<BaseOption>VB
Public NotInheritable Class OptionCollection
Inherits Collection(Of BaseOption)C++
public ref class OptionCollection sealed : public Collection<BaseOption^>F#
[<SealedAttribute>]
type OptionCollection =
class
inherit Collection<BaseOption>
end- Inheritance
- Object Collection<BaseOption> OptionCollection
Constructors
| OptionCollection | Initializes a new instance of the OptionCollection class |
Properties
| Count | Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<BaseOption>) |
| Item[Int32] | Gets or sets the element at the specified index. (Inherited from Collection<BaseOption>) |
| Item[String] | This read-only property can be used to retrieve an option by name |
Methods
| Add | Adds an object to the end of the Collection<T>. (Inherited from Collection<BaseOption>) |
| Clear | Removes all elements from the Collection<T>. (Inherited from Collection<BaseOption>) |
| Contains | Determines whether an element is in the Collection<T>. (Inherited from Collection<BaseOption>) |
| CopyTo | Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<BaseOption>) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetEnumerator | Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<BaseOption>) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IndexOf | Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<BaseOption>) |
| Insert | Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<BaseOption>) |
| ParseArguments | Parse an array of command line option strings into command line option instances |
| Remove | Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<BaseOption>) |
| RemoveAt | Removes the element at the specified index of the Collection<T>. (Inherited from Collection<BaseOption>) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WriteOptionSummary | This is used to write out a summary of the options |