BuildHelp Class

BuildHelp Class

This task is used to build help file output using the Sandcastle Help File Builder.

Inheritance Hierarchy

SystemObject
Microsoft.Build.UtilitiesTask
SandcastleBuilder.Utils.MSBuildBuildHelp

Namespace: SandcastleBuilder.Utils.MSBuild
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public class BuildHelp : Task, ICancelableTask, 
	ITask

Public Class BuildHelp
	Inherits Task
	Implements ICancelableTask, ITask

public ref class BuildHelp : public Task, 
	ICancelableTask, ITask

type BuildHelp =  
    class
        inherit Task
        interface ICancelableTask
        interface ITask
    end

The BuildHelp type exposes the following members.

Constructors

	Name	Description
	BuildHelp	Initializes a new instance of the BuildHelp class

Top

Methods

	Name	Description
	Cancel	Cancel the build
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	This is used to execute the task and perform the build (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.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Properties

	Name	Description
	AllHelpFiles	This is used to return a list of all files that resulted from the build (all help formats).
	AlwaysLoadProject	This is used to specify whether or not to load the specified ProjectFile rather than use the executing project.
	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.)
	Configuration	This is used to pass in the configuration to use for the build
	DumpLogOnFailure	This is used to set or get whether the log file is dumped to the task log if the help file project build fails.
	Help1Files	This is used to return a list of the HTML Help 1 (chm) files that resulted from the build
	Help2Files	This is used to return a list of the MS Help 2 (HxS) files that resulted from the build
	HelpKeywordPrefix	Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
	HelpViewerFiles	This is used to return a list of the MS Help Viewer (mshc) files that resulted from the build
	HostObject	Gets or sets the host object associated with the task. (Inherited from Task.)
	Log	Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
	OpenXmlFiles	This is used to return a list of the Open XML (docx) files that resulted from the build
	OutDir	This is used to specify the output directory containing the build output for solution and project documentation sources when using Team Build.
	Platform	This is used to pass in the platform to use for the build
	ProjectFile	This is used to pass in the project filename
	TaskResources	Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)
	Verbose	This is used to set or get the output logging verbosity flag
	WebsiteFiles	This is used to return a list of the website files that resulted from the build

Top

Remarks

All messages from this task are logged with a high priority since it will run for a long time and we need to see the progress messages to know it's doing something. If set to Normal and ran from within Visual Studio, it won't show the progress messages when the logging options are set to Minimal.

Reference

SandcastleBuilder.Utils.MSBuild Namespace