 | ShfbLatexComponent Class |
Represents a build component able to add LaTeX formatted formulas within
reference XML comments and conceptual content topics.
Inheritance HierarchyNamespace: Novacta.Documentation.ShfbTools
Assembly: Novacta.Documentation.ShfbLatexComponent (in Novacta.Documentation.ShfbLatexComponent.dll) Version: 2021.4.9.0
The ShfbLatexComponent type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ShfbLatexComponent |
Constructor
|
Properties| Name | Description | |
|---|---|---|
 | AdditionalPreambleCommands |
Gets or sets the additional preamble commands.
|
| BasePath |
Gets the working folder for SHFB.
|
| BuildAssembler |
This read-only property returns a reference to the build assembler instance using the component
(Inherited from BuildComponentCore.) |
| DviPng |
Gets the DviPng file processor.
|
| DviSvgm |
Gets the DviSvgm file processor.
|
| GroupId |
This is used to set an optional group ID for use with component events
(Inherited from BuildComponentCore.) |
| ImageDepthCorrection |
Gets or sets the image depth correction.
|
| ImageFileFormat |
Gets the image file format.
|
| ImageScalePercentage |
Gets or sets the image scale percentage.
|
| Latex |
Gets the LaTeX file processor.
|
| LatexDefaultMode |
Gets or sets the LaTeX default mode.
|
| OutputFolders |
Gets the output folders.
|
| RedirectFileProcessors |
Gets a value indicating whether file processors
standard output must be redirected to the
Sandcastle Help File Builder Log.
|
| WorkingFolder |
Gets the working folder for file processors.
|
Methods| Name | Description | |
|---|---|---|
 | Apply |
This is implemented to perform the component tasks.
(Overrides BuildComponentCore.Apply(XmlDocument, String).) |
| Dispose |
This implements the Dispose() interface to properly dispose of the build component.
(Inherited from BuildComponentCore.) |
| Dispose(Boolean) |
This can be overridden by derived classes to add their own disposal code if necessary.
(Inherited from BuildComponentCore.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
This handles garbage collection to ensure proper disposal of the build component if not done
explicitly with Dispose.
(Inherited from BuildComponentCore.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize |
Initialize the build component.
(Overrides BuildComponentCore.Initialize(XPathNavigator).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnComponentEvent |
This can be used to raise the ComponentEvent
event with the specified event arguments.
(Inherited from BuildComponentCore.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteMessage(MessageLevel, String, Object) |
This can be used to report a message
(Inherited from BuildComponentCore.) |
| WriteMessage(String, MessageLevel, String, Object) |
This can be used to report a message for a specific topic ID
(Inherited from BuildComponentCore.) |
See Also