HtmlHelp Members

NDoc Core

NDoc Documentation

HtmlHelp Members

HtmlHelp overview

Public Instance Constructors

HtmlHelp Constructor Initializes a new instance of the HtmlHelp class.

Public Instance Properties

DefaultTopicGets or sets the DefaultTopic property.
DirectoryNameGets the directory name containing the HTML Help files.
HtmlHelpCompilerGets or sets the path to the HTML Help Compiler.
IncludeFavoritesGets or sets the IncludeFavorites property.
ProjectNameGets the HTML Help project name.

Public Instance Methods

AddFileToContentsAdds a file to the contents file.
AddFileToProjectAdds a file to the HTML Help project file.
CloseBookInContentsCloses the last opened "book" in the contents file.
CloseContentsFileCloses the contents file.
CloseProjectFileCloses the HTML Help project file.
CompileProjectCompiles the HTML Help project.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetPathToCompiledHtmlFileGets the path the the CHM file.
GetPathToContentsFileGets the path the the HHC file.
GetPathToIndexFileGets the path the the HHK file.
GetPathToLogFileGets the path the the LOG file.
GetPathToProjectFileGets the path the the HHP file.
GetType (inherited from Object)Gets the Type of the current instance.
OpenBookInContentsCreates a new "book" in the HTML Help contents file.
OpenContentsFileOpens a HTML Help contents file for writing.
OpenProjectFileOpens an HTML Help project file for writing.
ToString (inherited from Object)Returns a String that represents the current Object.
WriteEmptyIndexFileWrites an empty index file.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

HtmlHelp Class | NDoc.Core Namespace