TargetTypeDictionary Class

This is a dictionary used to contain common target dictionaries with their associated link type

Definition

Namespace: Sandcastle.Tools.BuildComponents.Targets
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.2.18.0

C#View Source Request Example

public sealed class TargetTypeDictionary : IDictionary<string, Target>, 
	ICollection<KeyValuePair<string, Target>>, IEnumerable<KeyValuePair<string, Target>>, 
	IEnumerable, IDisposable

VBView Source Request Example

Public NotInheritable Class TargetTypeDictionary
	Implements IDictionary(Of String, Target), 
	ICollection(Of KeyValuePair(Of String, Target)), IEnumerable(Of KeyValuePair(Of String, Target)), 
	IEnumerable, IDisposable

C++View Source Request Example

public ref class TargetTypeDictionary sealed : IDictionary<String^, Target^>, 
	ICollection<KeyValuePair<String^, Target^>>, IEnumerable<KeyValuePair<String^, Target^>>, 
	IEnumerable, IDisposable

F#View Source Request Example

[<SealedAttribute>]
type TargetTypeDictionary = 
    class
        interface IDictionary<string, Target>
        interface ICollection<KeyValuePair<string, Target>>
        interface IEnumerable<KeyValuePair<string, Target>>
        interface IEnumerable
        interface IDisposable
    end

Inheritance: Object TargetTypeDictionary

Implements: ICollectionKeyValuePairString, Target, IDictionaryString, Target, IEnumerableKeyValuePairString, Target, IEnumerable, IDisposable

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. The structure allows access to all reference link targets within a set of multiple target dictionaries, each with a different reference link type. The target dictionary instances can be easily shared across multiple instances of the reference link components.

Constructors

TargetTypeDictionary

Constructor

Properties

Count	Gets the number of elements contained in the ICollectionT.
IsReadOnly	Gets a value indicating whether the ICollectionT is read-only.
Item	Gets or sets the element with the specified key.
Keys	Gets an ICollectionT containing the keys of the IDictionaryTKey, TValue.
NeedsMemberIdUrlResolver	This read-only property is used to determine if any of the target dictionaries require the member ID URL resolver to look up links.
Values	Gets an ICollectionT containing the values in the IDictionaryTKey, TValue.

Methods

Add(KeyValuePairString, Target)	Adds an item to the ICollectionT.
Add(ReferenceLinkType, TargetDictionary)	Add a target type dictionary to the collection
Add(String, Target)	Adds an element with the provided key and value to the IDictionaryTKey, TValue.
Clear	Removes all items from the ICollectionT.
Contains	Determines whether the ICollectionT contains a specific value.
ContainsKey	Determines whether the IDictionaryTKey, TValue contains an element with the specified key.
CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
Dispose	This implements the Dispose() interface to properly dispose of the target dictionaries
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetEnumerator	Returns an enumerator that iterates through the collection.
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
Remove(KeyValuePairString, Target)	Removes the first occurrence of a specific object from the ICollectionT.
Remove(String)	Removes the element with the specified key from the IDictionaryTKey, TValue.
ToString	Returns a string that represents the current object. (Inherited from Object)
TryGetValue(String, Target)	Gets the value associated with the specified key.
TryGetValue(String, Target, ReferenceLinkType)	This attempts to retrieve the item with the specified key, returning it along with the reference link type with which it is associated.