Sandcastle Help File Builder Documentation
Additional
This plug-in class is designed to add additional reference link targets to the Reflection Index
Data and Resolve Reference Links build components so that links can be created
to other third party help in a help collection or additional online content.
Definition
Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2024.2.18.0
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2024.2.18.0
C#
public sealed class AdditionalReferenceLinksPlugIn : IPlugIn,
IDisposable, IProgress<BuildProgressEventArgs>VB
Public NotInheritable Class AdditionalReferenceLinksPlugIn
Implements IPlugIn, IDisposable, IProgress(Of BuildProgressEventArgs)C++
public ref class AdditionalReferenceLinksPlugIn sealed : IPlugIn,
IDisposable, IProgress<BuildProgressEventArgs^>F#
[<SealedAttribute>]
type AdditionalReferenceLinksPlugIn =
class
interface IPlugIn
interface IDisposable
interface IProgress<BuildProgressEventArgs>
end- Inheritance
- Object AdditionalReferenceLinksPlugIn
- Implements
- IPlugIn, IDisposable, IProgressBuildProgressEventArgs
Constructors
| AdditionalReferenceLinksPlugIn | Initializes a new instance of the AdditionalReferenceLinksPlugIn class |
Properties
| ExecutionPoints | This read-only property returns a collection of execution points that define when the plug-in should be invoked during the build process. |
Methods
| Dispose | This implements the Dispose() interface to properly dispose of the plug-in object. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Execute | This method is used to execute the plug-in during the build process |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize | This method is used to initialize the plug-in at the start of the build process. |
| Report | This is called by the build process to report build progress for the reference link projects |
| ToString | Returns a string that represents the current object. (Inherited from Object) |