SqlTargetDictionary Class

This contains a collection of targets indexed by member ID stored in a SqlDictionaryTValue

Inheritance Hierarchy

SystemObject
Microsoft.Ddue.Tools.TargetsTargetDictionary
SandcastleBuilder.Components.TargetsSqlTargetDictionary

Namespace: SandcastleBuilder.Components.Targets
Assembly: SandcastleBuilder.Components (in SandcastleBuilder.Components.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public sealed class SqlTargetDictionary : TargetDictionary

Public NotInheritable Class SqlTargetDictionary
	Inherits TargetDictionary

public ref class SqlTargetDictionary sealed : public TargetDictionary

[<SealedAttribute>]
type SqlTargetDictionary =  
    class
        inherit TargetDictionary
    end

The SqlTargetDictionary type exposes the following members.

Constructors

	Name	Description
	SqlTargetDictionary	Constructor

Top

Methods

	Name	Description
	Add(KeyValuePairString, Target)	Adds an item to the ICollectionT. (Overrides TargetDictionaryAdd(KeyValuePairString, Target).)
	Add(String, Target)	Adds an element with the provided key and value to the IDictionaryTKey, TValue. (Overrides TargetDictionaryAdd(String, Target).)
	Clear	Removes all items from the ICollectionT. (Overrides TargetDictionaryClear.)
	Contains	Determines whether the ICollectionT contains a specific value. (Overrides TargetDictionaryContains(KeyValuePairString, Target).)
	ContainsKey	Determines whether the IDictionaryTKey, TValue contains an element with the specified key. (Overrides TargetDictionaryContainsKey(String).)
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Overrides TargetDictionaryCopyTo(KeyValuePairString, Target, Int32).)
	Dispose	This implements the Dispose() interface to properly dispose of the target dictionary (Inherited from TargetDictionary.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the collection. (Overrides TargetDictionaryGetEnumerator.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove(String)	Removes the element with the specified key from the IDictionaryTKey, TValue. (Inherited from TargetDictionary.)
	Remove(KeyValuePairString, Target)	Removes the first occurrence of a specific object from the ICollectionT. (Inherited from TargetDictionary.)
	ReportCacheStatistics	Report the cache usage for the build (Overrides TargetDictionaryReportCacheStatistics.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Gets the value associated with the specified key. (Overrides TargetDictionaryTryGetValue(String, Target).)

Top

Properties

	Name	Description
	BuildComponent	This read-only property returns the build component that owns the target dictionary (Inherited from TargetDictionary.)
	Count	Gets the number of elements contained in the ICollectionT. (Overrides TargetDictionaryCount.)
	DictionaryId	This is used to get or set the target dictionary's unique ID (Inherited from TargetDictionary.)
	DirectoryPath	This is used to get or set the path to the target files (Inherited from TargetDictionary.)
	FilePattern	This is used to get or set the file pattern to use when searching for target files (Inherited from TargetDictionary.)
	IsDisposed	This read-only property can be used to determine whether or not the target dictionary has been disposed. (Inherited from TargetDictionary.)
	IsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from TargetDictionary.)
	Item	Gets or sets the element with the specified key. (Overrides TargetDictionaryItemString.)
	Keys	Gets an ICollectionT containing the keys of the IDictionaryTKey, TValue. (Overrides TargetDictionaryKeys.)
	NamespaceFileFilter	This read-only property returns any optional namespace files used to filter what gets loaded (Inherited from TargetDictionary.)
	Recurse	This is used to get or set whether to recurse into subfolders of DirectoryPath when loading target files. (Inherited from TargetDictionary.)
	Values	Gets an ICollectionT containing the values in the IDictionaryTKey, TValue. (Overrides TargetDictionaryValues.)

Top

Remarks

The behavior of this dictionary is to return null if a target ID is not found and to replace existing entries if a duplicate ID is added. All targets are stored in a SQL database. The initial use will create the database slowing down initialization on first use. Subsequent uses will not need to recreate it. The trade off is that it can use much less memory at the expense of some build speed for each topic. The speed difference is offset somewhat by the shorter initialization time.

Thread Safety

Static members of this type are not safe for multi-threaded operations. Instance members of this type are not safe for multi-threaded operations.

Reference

SandcastleBuilder.Components.Targets Namespace