 | ShfbLatexPlugIn Class |
Provides support for representing LaTeX formatted formulas using SVG files in
reference XML comments and conceptual content topics for MS Help Viewer files created with
Sandcastle Help File Builder.
Inheritance HierarchyNamespace: Novacta.Documentation.ShfbTools
Assembly: Novacta.Documentation.ShfbLatexPlugIn (in Novacta.Documentation.ShfbLatexPlugIn.dll) Version: 2021.4.9.0
The ShfbLatexPlugIn type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShfbLatexPlugIn | Initializes a new instance of the ShfbLatexPlugIn class |
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.
|
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
|
 | Finalize |
This handles garbage collection to ensure proper disposal of the plug-in if not done explicitly
with Dispose.
(Overrides ObjectFinalize.) |
| 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.) |
RemarksThe HelpFileBuilderPlugInExportAttribute is used to export your plug-in so that the help
file builder finds it and can make use of it. The example below shows the basic usage for a common
plug-in. Set the additional attribute values as needed:
- IsConfigurable - Set this to true if your plug-in contains configurable settings. The ConfigurePlugIn method will be called to let the user change the settings.
- RunsInPartialBuild - Set this to true if your plug-in should run in partial builds used to generate reflection data for the API Filter editor dialog or namespace comments used for the Namespace Comments editor dialog. Typically, this is left set to false.
See Also