IPlugIn Interface

Definition

Namespace

Sandcastle.Core.PlugIn

Assembly

Sandcastle.Core.dll

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

public interface IPlugIn : 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

Execute(ExecutionContext)	This method is used to execute the plug-in during the build process
Initialize(IBuildProcess, XElement)	This method is used to initialize the plug-in at the start of the build process