PlugInConfigurationDictionary Class

This dictionary class is used to hold the configurations for third party build process plug-ins such as the Additional Content Only plug-in.

Inheritance Hierarchy

SystemObject
System.Collections.GenericDictionaryString, PlugInConfiguration
SandcastleBuilder.Utils.BuildComponentPlugInConfigurationDictionary

Namespace: SandcastleBuilder.Utils.BuildComponent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public class PlugInConfigurationDictionary : Dictionary<string, PlugInConfiguration>

Public Class PlugInConfigurationDictionary
	Inherits Dictionary(Of String, PlugInConfiguration)

public ref class PlugInConfigurationDictionary : public Dictionary<String^, PlugInConfiguration^>

type PlugInConfigurationDictionary =  
    class
        inherit Dictionary<string, PlugInConfiguration>
    end

The PlugInConfigurationDictionary type exposes the following members.

Constructors

	Name	Description
	PlugInConfigurationDictionary	Default constructor

Top

Methods

	Name	Description
	Add(TKey, TValue)	Adds the specified key and value to the dictionary. (Inherited from DictionaryString, PlugInConfiguration.)
	Add(String, Boolean, String)	Add a new item to the dictionary
	Clear	Removes all keys and values from the DictionaryTKey, TValue. (Inherited from DictionaryString, PlugInConfiguration.)
	ContainsKey	Determines whether the DictionaryTKey, TValue contains the specified key. (Inherited from DictionaryString, PlugInConfiguration.)
	ContainsValue	Determines whether the DictionaryTKey, TValue contains a specific value. (Inherited from DictionaryString, PlugInConfiguration.)
	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.)
	FromXml	This is used to load existing plug-in configuration items from the project file
	GetEnumerator	Returns an enumerator that iterates through the DictionaryTKey, TValue. (Inherited from DictionaryString, PlugInConfiguration.)
	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, PlugInConfiguration.)
	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, PlugInConfiguration.)
	Remove	Removes the value with the specified key from the DictionaryTKey, TValue. (Inherited from DictionaryString, PlugInConfiguration.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	ToXml	This is used to write the plug-in 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, PlugInConfiguration.)

Top

Properties

	Name	Description
	Comparer	Gets the IEqualityComparerT that is used to determine equality of keys for the dictionary. (Inherited from DictionaryString, PlugInConfiguration.)
	Count	Gets the number of key/value pairs contained in the DictionaryTKey, TValue. (Inherited from DictionaryString, PlugInConfiguration.)
	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, PlugInConfiguration.)
	Keys	Gets a collection containing the keys in the DictionaryTKey, TValue. (Inherited from DictionaryString, PlugInConfiguration.)
	ProjectFile	This returns a reference to the owning project file
	Values	Gets a collection containing the values in the DictionaryTKey, TValue. (Inherited from DictionaryString, PlugInConfiguration.)

Top

Reference

SandcastleBuilder.Utils.BuildComponent Namespace