Sandcastle Help File Builder Documentation
Resolve
This build component is used to resolve links to reference topics
Definition
Namespace: Sandcastle.Tools.BuildComponents
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#
public class ResolveReferenceLinksComponent : BuildComponentCoreVB
Public Class ResolveReferenceLinksComponent
Inherits BuildComponentCoreC++
public ref class ResolveReferenceLinksComponent : public BuildComponentCoreF#
type ResolveReferenceLinksComponent =
class
inherit BuildComponentCore
end- Inheritance
- Object BuildComponentCore ResolveReferenceLinksComponent
Constructors
| ResolveReferenceLinksComponent | Constructor |
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 |
This abstract method must be overridden to apply the build component's changes to the specified
document.
(Overrides BuildComponentCoreApply(XmlDocument, String)) |
| CreateMemberIdResolver(XPathNavigator) | This is used to create a member ID URL resolver for the component to use in looking up help website URLs. |
| CreateMemberIdResolver(IDictionaryString, String, Boolean) | This is used to create a member ID URL resolver for the component to use in looking up help website URLs. |
| CreateTargetDictionary | 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(Boolean) |
This is overridden to save the updated cache information and dispose of target information
(Overrides BuildComponentCoreDispose(Boolean)) |
| 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 build component if not done
explicitly with Dispose.
(Inherited from BuildComponentCore) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
This abstract method must be overridden to initialize the component
(Overrides BuildComponentCoreInitialize(XPathNavigator)) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnComponentEvent |
This can be used to raise the ComponentEvent
event with the specified event arguments.
(Inherited from BuildComponentCore) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UpdateUrlCache | This is used to update the URL cache file |
| WriteMessage(MessageLevel, String, Object) |
This can be used to report a message
(Inherited from BuildComponentCore) |
| WriteMessage(String, MessageLevel, String, Object) |
This can be used to report a message for a specific topic ID
(Inherited from BuildComponentCore) |
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 |