TargetDictionary Class
Definition
- Assembly
- Sandcastle.Tools.BuildComponents.dll
This is a base class used for a collection of targets indexed by member ID
[Serializable]
public abstract class TargetDictionary : IDictionary<string, Target>, ICollection<KeyValuePair<string, Target>>, IEnumerable<KeyValuePair<string, Target>>, IEnumerable, IDisposable- Inheritance
-
TargetDictionary
- Implements
- Derived
Constructors
| TargetDictionary(BuildComponentCore, XPathNavigator) |
Constructor |
Properties
| BuildComponent |
This read-only property returns the build component that owns the target dictionary |
| Count | |
| DictionaryId |
This is used to get or set the target dictionary's unique ID |
| DirectoryPath |
This is used to get or set the path to the target files |
| FilePattern |
This is used to get or set the file pattern to use when searching for target files |
| IsDisposed |
This read-only property can be used to determine whether or not the target dictionary has been disposed. |
| IsReadOnly | |
| Keys | |
| NamespaceFileFilter |
This read-only property returns any optional namespace files used to filter what gets loaded |
| Recurse |
This is used to get or set whether to recurse into subfolders of DirectoryPath when loading target files. |
| this[string] | |
| Values |
Methods
| Add(KeyValuePair<string, Target>) | |
| Add(string, Target) | |
| Clear() | |
| Contains(KeyValuePair<string, Target>) | |
| ContainsKey(string) | |
| CopyTo(KeyValuePair<string, Target>[], int) | |
| Dispose() |
This implements the Dispose() interface to properly dispose of the target dictionary |
| Dispose(bool) |
This can be overridden by derived classes to add their own disposal code if necessary. |
| GetEnumerator() | |
| LoadTargetDictionary(int) |
This helper method can be called to find all target files and load them into the dictionary |
| Remove(KeyValuePair<string, Target>) | |
| Remove(string) | |
| ReportCacheStatistics() |
This can be overridden in derived classes to report cache usage statistics after the build |
| TryGetValue(string, out Target) | |
| ~TargetDictionary() |
This handles garbage collection to ensure proper disposal of the target dictionary if not done explicitly with Dispose(). |