CleanHelp Class

CleanHelp Class

This task is used to clean (remove) help file output from the last build.

Inheritance Hierarchy

SystemObject
Microsoft.Build.UtilitiesTask
SandcastleBuilder.Utils.MSBuildCleanHelp

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

Syntax

C++

Copy

public class CleanHelp : Task

Public Class CleanHelp
	Inherits Task

public ref class CleanHelp : public Task

type CleanHelp =  
    class
        inherit Task
    end

The CleanHelp type exposes the following members.

Constructors

	Name	Description
	CleanHelp	Initializes a new instance of the CleanHelp class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	This is used to execute the task and clean the output folder (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
	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.)
	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.)
	Log	Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
	LogFileLocation	This is used to pass in the optional log filename that needs to be cleaned.
	OutputPath	This is used to pass in the output path that needs to be cleaned
	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.)
	WorkingPath	This is used to pass in the optional working path that needs to be cleaned.

Top

Remarks

All messages from this task are logged with a high priority. 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