 | SandcastleHtmlExtract Class |
This is the console mode application used to extract title and keyword information from HTML files for
use in creating the CHM table of contents and keyword index files.
Inheritance HierarchyNamespace: SandcastleBuilder.HtmlExtract
Assembly: SandcastleHtmlExtract (in SandcastleHtmlExtract.exe) Version: 2014.11.22.0
SyntaxThe SandcastleHtmlExtract type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SandcastleHtmlExtract | Initializes a new instance of the SandcastleHtmlExtract class |
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
| Execute |
This is used to execute the task and process the HTML files
(Overrides TaskExecute.) |
 | 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 a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | Main |
Main program entry point
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | BuildEngine | Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.) |
| BuildEngine2 | Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.) |
| BuildEngine3 | Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.) |
| Help1Folder |
This is used to set the HTML Help 1 file folder name containing the Help 1 files to be processed.
|
 | HelpKeywordPrefix | Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.) |
| HostObject | Gets or sets the host object associated with the task. (Inherited from Task.) |
| LanguageId |
This is used to set the language ID (LCID)
|
| LocalizedFolder |
This is used to set the localized output folder name
|
| Log | Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.) |
| MaxDegreeOfParallelism |
This is used to get or set the maximum degree of parallelism used to process the HTML files
|
| OutputFolder |
This is used to set the general output folder name
|
| ProjectName |
This is used to set the project name
|
| TaskResources | Gets or sets the culture-specific resources associated with the task. (Inherited from Task.) |
| TocFile |
This is used to set the table of contents XML filename
|
| WebsiteFolder |
This is used to set the website file folder name containing the website files to be processed.
|
See Also