CompletionNotificationPlugIn Class

This plug-in class is designed to run after the build completes to send notification of the completion status via e-mail. The log file can be sent as an attachment.

Inheritance Hierarchy

SystemObject
SandcastleBuilder.PlugInsCompletionNotificationPlugIn

Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public sealed class CompletionNotificationPlugIn : IPlugIn, 
	IDisposable

Public NotInheritable Class CompletionNotificationPlugIn
	Implements IPlugIn, IDisposable

public ref class CompletionNotificationPlugIn sealed : IPlugIn, 
	IDisposable

[<SealedAttribute>]
type CompletionNotificationPlugIn =  
    class
        interface IPlugIn
        interface IDisposable
    end

The CompletionNotificationPlugIn type exposes the following members.

Constructors

	Name	Description
	CompletionNotificationPlugIn	Initializes a new instance of the CompletionNotificationPlugIn class

Top

Methods

	Name	Description
	ConfigurePlugIn	This method is used by the Sandcastle Help File Builder to let the plug-in perform its own configuration.
	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 a hash function for a particular type. (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
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	ExecutionPoints	This read-only property returns a collection of execution points that define when the plug-in should be invoked during the build process.

Top

Reference

SandcastleBuilder.PlugIns Namespace