Sandcastle Help File Builder Documentation
Title
This class is used to extract title and keyword information from HTML files for use in creating the Help
1 (CHM) table of contents and keyword index files. It can also optionally convert the files to a
different encoding in order to build HTML Help 1 files that use a different language.
Definition
Namespace: SandcastleBuilder.Utils.BuildEngine
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public class TitleAndKeywordHtmlExtractVB
Public Class TitleAndKeywordHtmlExtractC++
public ref class TitleAndKeywordHtmlExtractF#
type TitleAndKeywordHtmlExtract = class end- Inheritance
- Object TitleAndKeywordHtmlExtract
Constructors
| TitleAndKeywordHtmlExtract | Constructor |
Properties
| Help1Folder | This is used to get or set the HTML Help 1 file folder name containing the Help 1 files to be processed. |
| LanguageSettings | This read-only property returns the list of language settings |
| LocalizedFolder | This is used to get or set the localized output folder name |
| MaxDegreeOfParallelism | This is used to get or set the maximum degree of parallelism used to process the HTML files |
| WebsiteFolder | This is used to get or set the website file folder name containing the website files to be processed. |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExtractHtmlInfo | This extracts the information from the HTML files |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |