SqlDictionary(TValue) Class

SqlDictionaryTValue Class

This is a simple dictionary that stores its data in a SQL Server database table. An optional group ID can be used to segregate values within the dictionary.

Inheritance Hierarchy

SystemObject
SandcastleBuilder.ComponentsSqlDictionaryTValue

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

Syntax

C++

Copy

public sealed class SqlDictionary<TValue> : IDictionary<string, TValue>, 
	ICollection<KeyValuePair<string, TValue>>, IEnumerable<KeyValuePair<string, TValue>>, 
	IEnumerable, IDisposable

Public NotInheritable Class SqlDictionary(Of TValue)
	Implements IDictionary(Of String, TValue), ICollection(Of KeyValuePair(Of String, TValue)), 
	IEnumerable(Of KeyValuePair(Of String, TValue)), IEnumerable, 
	IDisposable

generic<typename TValue>
public ref class SqlDictionary sealed : IDictionary<String^, TValue>, 
	ICollection<KeyValuePair<String^, TValue>>, IEnumerable<KeyValuePair<String^, TValue>>, 
	IEnumerable, IDisposable

[<SealedAttribute>]
type SqlDictionary<'TValue> =  
    class
        interface IDictionary<string, 'TValue>
        interface ICollection<KeyValuePair<string, 'TValue>>
        interface IEnumerable<KeyValuePair<string, 'TValue>>
        interface IEnumerable
        interface IDisposable
    end

Type Parameters

TValue: The type of the value

The SqlDictionaryTValue type exposes the following members.

Constructors

	Name	Description
	SqlDictionaryTValue(String, String, String, String)	Simple dictionary constructor
	SqlDictionaryTValue(String, String, String, String, String, String)	Grouped dictionary constructor

Top

Methods

	Name	Description
	Add(KeyValuePairString, TValue)	Adds an item to the ICollectionT.
	Add(String, TValue)	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	Dispose of the SQL dictionary
	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 a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Purge	This is used to purge all data from the dictionary
	Remove(KeyValuePairString, TValue)	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	Gets the value associated with the specified key.

Top

Properties

	Name	Description
	Count	Gets the number of elements contained in the ICollectionT.
	CurrentLocalCacheCount	This read-only property returns the current number of local cache entries in use
	GroupId	This read-only property returns the group ID
	IsDisposed	This read-only property returns whether or not the cache has been disposed of
	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.
	LocalCacheFlushCount	This read-only property returns the number of times the local cache was flushed because it filled up
	LocalCacheSize	Set this to a non-zero value to enable local caching of values to speed up read-only access
	Values	Gets an ICollectionT containing the values in the IDictionaryTKey, TValue.

Top

Remarks

This dictionary is intended for use in Sandcastle build components to store data needed for the build. The key type is always a string as is the group ID type if used. The value type is indicated using the TValue type parameter and is assumed to be either a String or a reference type.

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 Namespace