 | ComponentConfigurationDictionary Class |
This dictionary class is used to hold the third party build component configuration properties for a
project such as the Code Block Component.
Inheritance HierarchySystemObject
System.Collections.GenericDictionaryString, BuildComponentConfiguration
SandcastleBuilder.Utils.BuildComponentComponentConfigurationDictionary
System.Collections.GenericDictionaryString, BuildComponentConfiguration
SandcastleBuilder.Utils.BuildComponentComponentConfigurationDictionary
Namespace: SandcastleBuilder.Utils.BuildComponent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
SyntaxThe ComponentConfigurationDictionary type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ComponentConfigurationDictionary |
Default constructor
|
Methods| Name | Description | |
|---|---|---|
| Add(TKey, TValue) | Adds the specified key and value to the dictionary. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| Add(String, Boolean, String) |
Add a new item to the dictionary
|
| Clear | Removes all keys and values from the DictionaryTKey, TValue. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| ContainsKey | Determines whether the DictionaryTKey, TValue contains the specified key. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| ContainsValue | Determines whether the DictionaryTKey, TValue contains a specific value. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| Equals | (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.) |
| FromXml |
This is used to load existing component configuration items from the project file
|
| GetEnumerator | Returns an enumerator that iterates through the DictionaryTKey, TValue. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetObjectData | Implements the ISerializable interface and returns the data needed to serialize the DictionaryTKey, TValue instance. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDeserialization | Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| Remove | Removes the value with the specified key from the DictionaryTKey, TValue. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToXml |
This is used to write the component configuration info to an XML fragment ready for storing in the
project file.
|
| TryGetValue | Gets the value associated with the specified key. (Inherited from DictionaryString, BuildComponentConfiguration.) |
Properties| Name | Description | |
|---|---|---|
 | Comparer | Gets the IEqualityComparerT that is used to determine equality of keys for the dictionary. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| Count | Gets the number of key/value pairs contained in the DictionaryTKey, TValue. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| IsDirty |
This is used to get or set the dirty state of the collection
|
| Item | Gets or sets the value associated with the specified key. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| Keys | Gets a collection containing the keys in the DictionaryTKey, TValue. (Inherited from DictionaryString, BuildComponentConfiguration.) |
| Values | Gets a collection containing the values in the DictionaryTKey, TValue. (Inherited from DictionaryString, BuildComponentConfiguration.) |
See Also