Click or drag to resize
Sandcastle Help File BuilderSandcastleHtmlExtract 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 Hierarchy
SystemObject
  Microsoft.Build.UtilitiesTask
    SandcastleBuilder.HtmlExtractSandcastleHtmlExtract

Namespace: SandcastleBuilder.HtmlExtract
Assembly: SandcastleHtmlExtract (in SandcastleHtmlExtract.exe) Version: 2014.11.22.0
Syntax
public class SandcastleHtmlExtract : Task

The SandcastleHtmlExtract type exposes the following members.

Constructors
  NameDescription
Public methodSandcastleHtmlExtract
Initializes a new instance of the SandcastleHtmlExtract class
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecute
This is used to execute the task and process the HTML files
(Overrides TaskExecute.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberMain
Main program entry point
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyBuildEngine
Gets or sets the instance of the IBuildEngine object used by the task.
(Inherited from Task.)
Public propertyBuildEngine2
Gets the instance of the IBuildEngine2 object used by the task.
(Inherited from Task.)
Public propertyBuildEngine3
Gets the instance of the IBuildEngine3 object used by the task.
(Inherited from Task.)
Public propertyHelp1Folder
This is used to set the HTML Help 1 file folder name containing the Help 1 files to be processed.
Protected propertyHelpKeywordPrefix
Gets or sets the prefix used to compose Help keywords from resource names.
(Inherited from Task.)
Public propertyHostObject
Gets or sets the host object associated with the task.
(Inherited from Task.)
Public propertyLanguageId
This is used to set the language ID (LCID)
Public propertyLocalizedFolder
This is used to set the localized output folder name
Public propertyLog
Gets an instance of a TaskLoggingHelper class containing task logging methods.
(Inherited from Task.)
Public propertyMaxDegreeOfParallelism
This is used to get or set the maximum degree of parallelism used to process the HTML files
Public propertyOutputFolder
This is used to set the general output folder name
Public propertyProjectName
This is used to set the project name
Protected propertyTaskResources
Gets or sets the culture-specific resources associated with the task.
(Inherited from Task.)
Public propertyTocFile
This is used to set the table of contents XML filename
Public propertyWebsiteFolder
This is used to set the website file folder name containing the website files to be processed.
Top
See Also