LightweightWebsiteStylePlugIn Class

This plug-in class is used to add elements for the lightweight website style such as a search box and a table of contents in the topics similar to the MSDN lightweight style.

Definition

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

C#View Source Request Example

public sealed class LightweightWebsiteStylePlugIn : IPlugIn, 
	IDisposable

VBView Source Request Example

Public NotInheritable Class LightweightWebsiteStylePlugIn
	Implements IPlugIn, IDisposable

C++View Source Request Example

public ref class LightweightWebsiteStylePlugIn sealed : IPlugIn, 
	IDisposable

F#View Source Request Example

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

Inheritance: Object LightweightWebsiteStylePlugIn

Implements: IPlugIn, IDisposable

Remarks

This is a presentation style dependency plug-in and has no configurable elements. As such, it is hidden.

Constructors

LightweightWebsiteStylePlugIn

Initializes a new instance of the LightweightWebsiteStylePlugIn class

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.
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 the default hash function. (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)