Sandcastle Help File Builder Documentation
IPlug
This interface defines the methods required to implement a Sandcastle Help File Builder build process
plug-in.
Definition
Namespace: SandcastleBuilder.Utils.BuildComponent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
C#
public interface IPlugIn : IDisposableVB
Public Interface IPlugIn
Inherits IDisposableC++
public interface class IPlugIn : IDisposableF#
type IPlugIn =
interface
interface IDisposable
end- Implements
- IDisposable
Remarks
Derived classes must also implement the IDisposable interface. Plug-ins are
singletons in nature. The composition container will create instances as needed and will dispose of them
when the container is disposed of.
Properties
| ExecutionPoints | This read-only property returns an enumerable list of execution points that define when the plug-in should be invoked during the build process. |
Methods
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| Execute | This method is used to execute the plug-in during the build process |
| Initialize | This method is used to initialize the plug-in at the start of the build process |