The IPlugIn type exposes the following members.

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.

Properties

  NameDescription
Public propertyCopyright
This read-only property returns the copyright information for the plug-in.
Public propertyDescription
This read-only property returns a brief description of the plug-in
Public propertyExecutionPoints
This read-only property returns a collection of execution points that define when the plug-in should be invoked during the build process.
Public propertyName
This read-only property returns a friendly name for the plug-in
Public propertyRunsInPartialBuild
This read-only property returns true if the plug-in should run in a partial build or false if it should not.
Public propertyVersion
This read-only property returns the version of the plug-in

See Also