Sandcastle Help File Builder Documentation
Target
This is a base class used for a collection of targets indexed by member ID
Definition
Namespace: Sandcastle.Tools.BuildComponents.Targets
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.2.18.0
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.2.18.0
C#
[SerializableAttribute]
public abstract class TargetDictionary : IDictionary<string, Target>,
ICollection<KeyValuePair<string, Target>>, IEnumerable<KeyValuePair<string, Target>>,
IEnumerable, IDisposableVB
<SerializableAttribute>
Public MustInherit Class TargetDictionary
Implements IDictionary(Of String, Target),
ICollection(Of KeyValuePair(Of String, Target)), IEnumerable(Of KeyValuePair(Of String, Target)),
IEnumerable, IDisposableC++
[SerializableAttribute]
public ref class TargetDictionary abstract : IDictionary<String^, Target^>,
ICollection<KeyValuePair<String^, Target^>>, IEnumerable<KeyValuePair<String^, Target^>>,
IEnumerable, IDisposableF#
[<AbstractClassAttribute>]
[<SerializableAttribute>]
type TargetDictionary =
class
interface IDictionary<string, Target>
interface ICollection<KeyValuePair<string, Target>>
interface IEnumerable<KeyValuePair<string, Target>>
interface IEnumerable
interface IDisposable
end- Inheritance
- Object TargetDictionary
- Derived
Constructors
| TargetDictionary | Constructor |
Properties
| BuildComponent | This read-only property returns the build component that owns the target dictionary |
| Count | Gets the number of elements contained in the ICollectionT. |
| 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 | 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. |
| 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. |
| Values | Gets an ICollectionT containing the values in the IDictionaryTKey, TValue. |
Methods
| Add(KeyValuePairString, Target) | Adds an item to the ICollectionT. |
| 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 dictionary |
| Dispose(Boolean) | This can be overridden by derived classes to add their own disposal code if necessary. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
This handles garbage collection to ensure proper disposal of the target dictionary if not done
explicitly with Dispose.
(Overrides ObjectFinalize) |
| 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) |
| LoadTargetDictionary | This helper method can be called to find all target files and load them into the dictionary |
| MemberwiseClone | Creates a shallow copy of the current Object. (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. |
| ReportCacheStatistics | This can be overridden in derived classes to report cache usage statistics after the build |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetValue | Gets the value associated with the specified key. |