Sandcastle Help File Builder Documentation
Indexed
This abstract base class is used to create indexed caches of information represented by XPathNavigators
such as reflection information and XML comments.
Definition
Namespace: Sandcastle.Tools.BuildComponents.Commands
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2025.9.30.0
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2025.9.30.0
C#
public abstract class IndexedCache : IDisposableVB
Public MustInherit Class IndexedCache
Implements IDisposableC++
public ref class IndexedCache abstract : IDisposableF#
[<AbstractClassAttribute>]
type IndexedCache =
class
interface IDisposable
end- Inheritance
- Object IndexedCache
- Derived
- Implements
- IDisposable
Constructors
| IndexedCache | Constructor |
Properties
| Component | This read-only property returns a reference to the CopyFromIndexComponent that owns it |
| Count | This read-only property returns a count of the items in the indexed cache |
| IsDisposed | This read-only property can be used to determine whether or not the indexed cache has been disposed |
| Item | This read-only property returns the value in the indexed cache for the given key |
| KeyExpression | This read-only property returns the XPath expression used to extract the key from values |
| Name | This read-only property returns the name of the index cache |
| ValueExpression | This read-only property returns the XPath expression used to search for values in the XML files |
Methods
| AddDocuments | This is used to index documents and add their key/file mappings to the cache |
| Dispose | This implements the Dispose() interface to properly dispose of the indexed cache |
| 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 indexed cache if not done
explicitly with Dispose.
(Overrides ObjectFinalize) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetKeys | This returns an enumerable list of all key values from the specified XML file based on the expressions for this cache. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValues | This returns an enumerable list of all key/value pairs from the specified XML file based on the expressions for this cache. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| 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) |