ResolveReferenceLinksComponent Class
Definition
- Namespace
- Sandcastle.Tools.BuildComponents
- Assembly
- Sandcastle.Tools.BuildComponents.dll
This build component is used to resolve links to reference topics
public class ResolveReferenceLinksComponent : BuildComponentCore, IDisposable- Inheritance
-
ResolveReferenceLinksComponent
- Implements
Constructors
| ResolveReferenceLinksComponent(IBuildAssembler) |
Constructor |
Fields
| SharedMemberUrlCacheId |
This is used as the key name when sharing the URL cache across instances |
| SharedReferenceTargetsId |
This is used as the key name when sharing the target dictionaries across instances |
Properties
| BuildAssembler |
This read-only property returns a reference to the build assembler instance using the component (Inherited from BuildComponentCore) |
| GroupId |
This is used to set an optional group ID for use with component events (Inherited from BuildComponentCore) |
| Targets |
This read-only property returns the target type dictionary |
| UrlResolver |
This read-only property returns the member ID URL resolver instance |
Methods
| Apply(XmlDocument, string) |
This abstract method must be overridden to apply the build component's changes to the specified document. |
| CreateMemberIdResolver(IDictionary<string, string>, bool) |
This is used to create a member ID URL resolver for the component to use in looking up help website URLs. |
| CreateMemberIdResolver(XPathNavigator) |
This is used to create a member ID URL resolver for the component to use in looking up help website URLs. |
| CreateTargetDictionary(XPathNavigator) |
This is used to create a TargetDictionary used to store reference link targets |
| Dispose() |
This implements the Dispose() interface to properly dispose of the build component. (Inherited from BuildComponentCore) |
| Dispose(bool) |
This is overridden to save the updated cache information and dispose of target information |
| Initialize(XPathNavigator) |
This abstract method must be overridden to initialize the component |
| UpdateUrlCache() |
This is used to update the URL cache file |