Sandcastle Help File Builder Documentation
Version
This plug-in class is designed to generate version information for assemblies in the current project and
others related to the same product that can be merged into the current project's help file topics.
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 VersionBuilderPlugIn : IPlugIn,
IDisposable, IProgress<BuildProgressEventArgs>VB
Public NotInheritable Class VersionBuilderPlugIn
Implements IPlugIn, IDisposable, IProgress(Of BuildProgressEventArgs)C++
public ref class VersionBuilderPlugIn sealed : IPlugIn,
IDisposable, IProgress<BuildProgressEventArgs^>F#
[<SealedAttribute>]
type VersionBuilderPlugIn =
class
interface IPlugIn
interface IDisposable
interface IProgress<BuildProgressEventArgs>
end- Inheritance
- Object VersionBuilderPlugIn
- Implements
- IPlugIn, IDisposable, IProgressBuildProgressEventArgs
Constructors
| VersionBuilderPlugIn | Initializes a new instance of the VersionBuilderPlugIn 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 |
| Report | This is called by the build process to report build progress for the reference link projects |
| ToString | Returns a string that represents the current object. (Inherited from Object) |