Click or drag to resize
Sandcastle Help File Builder

IPlugIn Interface

This interface defines the methods required to implement a Sandcastle Help File Builder build process plug-in.

Namespace:  SandcastleBuilder.Utils.BuildComponent
Assembly:  SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2019.4.14.0
Syntax
public interface IPlugIn : IDisposable
Request Example View Source

The IPlugIn type exposes the following members.

Properties
  NameDescription
Public propertyExecutionPoints
This read-only property returns an enumerable list of execution points that define when the plug-in should be invoked during the build process.
Top
Methods
  NameDescription
Public methodConfigurePlugIn
This method is used by the Sandcastle Help File Builder to let the plug-in perform its own configuration.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodExecute
This method is used to execute the plug-in during the build process
Public methodInitialize
This method is used to initialize the plug-in at the start of the build process
Top
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.
See Also