Sandcastle Help File Builder Documentation
Toc
This plug-in class can be used to exclude API members from the table of contents via the
<tocexclude /> XML comment tag. The excluded items are still accessible in the help file
via other topic links.
Definition
Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2024.2.18.0
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2024.2.18.0
C#
public sealed class TocExcludePlugIn : IPlugIn,
IDisposableVB
Public NotInheritable Class TocExcludePlugIn
Implements IPlugIn, IDisposableC++
public ref class TocExcludePlugIn sealed : IPlugIn,
IDisposableF#
[<SealedAttribute>]
type TocExcludePlugIn =
class
interface IPlugIn
interface IDisposable
end- Inheritance
- Object TocExcludePlugIn
- Implements
- IPlugIn, IDisposable
Constructors
| TocExcludePlugIn | Initializes a new instance of the TocExcludePlugIn class |
Properties
| ExecutionPoints | This read-only property returns a collection of execution points that define when the plug-in should be invoked during the build process. |
Methods
| 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 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) |