Click or drag to resize
Sandcastle Help File BuilderBuild2xHelpFile Class
This task is used to run HXCOMP.EXE which is used to compile a Help 2 (HxS) help file
Inheritance Hierarchy

Namespace: SandcastleBuilder.Utils.MSBuild
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax
public class Build2xHelpFile : ToolTask

The Build2xHelpFile type exposes the following members.

Constructors
  NameDescription
Public methodBuild2xHelpFile
Initializes a new instance of the Build2xHelpFile class
Top
Methods
  NameDescription
Protected methodCallHostObjectToExecute
Calls the host object to perform the work of the task.
(Inherited from ToolTask.)
Public methodCancel
Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.
(Inherited from ToolTask.)
Protected methodDeleteTempFile
Deletes the specified temporary file.
(Inherited from ToolTask.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecute
This is overridden to set the working folder before executing the task and to dump the compiler log file after the build.
(Overrides ToolTaskExecute.)
Protected methodExecuteTool
Creates a temporoary response (.rsp) file and runs the executable file.
(Inherited from ToolTask.)
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.)
Protected methodGenerateCommandLineCommands
Generate the command line parameters
(Overrides ToolTaskGenerateCommandLineCommands.)
Protected methodGenerateFullPathToTool
This returns the full path to the tool
(Overrides ToolTaskGenerateFullPathToTool.)
Protected methodGenerateResponseFileCommands
Returns a string value containing the command line arguments to add to the response (.rsp) file before running the executable file.
(Inherited from ToolTask.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetProcessStartInfo
Initializes the information required to spawn the process executing the tool.
(Inherited from ToolTask.)
Protected methodGetResponseFileSwitch
Returns the command line switch used by the executable file to specifiy a response (.rsp) file.
(Inherited from ToolTask.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodGetWorkingDirectory
Returns the directory in which to run the executable file.
(Inherited from ToolTask.)
Protected methodHandleTaskExecutionErrors
This is overridden to invert the result of the HXCOMP exit code
(Overrides ToolTaskHandleTaskExecutionErrors.)
Protected methodInitializeHostObject
Initializes the host object of the task.
(Inherited from ToolTask.)
Protected methodLogEventsFromTextOutput
Parses a single line of text to identify any errors or warnings in canonical format.
(Inherited from ToolTask.)
Protected methodLogPathToTool
Logs the tool name and path to all registered loggers.
(Inherited from ToolTask.)
Protected methodLogToolCommand
Logs the starting point of the run to all registered loggers.
(Inherited from ToolTask.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodSkipTaskExecution
Indicates whether task execution should be skipped.
(Inherited from ToolTask.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateParameters
Validate the parameters
(Overrides ToolTaskValidateParameters.)
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 propertyEchoOff
Indicates that command line echoing is turned off.
(Inherited from ToolTask.)
Protected propertyEnvironmentOverride Obsolete.
Gets a set of environment variable name-value pairs. Designed to be overridden in a custom task class (derived from ToolTask) to return a set of new or altered environment variables to create the execution context of the associated tool.
(Inherited from ToolTask.)
Public propertyEnvironmentVariables
Array of equals-separated pairs of environment variables that should be passed to the spawned executable, in addition to (or selectively overriding) the regular environment block.
(Inherited from ToolTask.)
Public propertyExitCode
Gets the returned exit code of the executable file.
(Inherited from ToolTask.)
Protected propertyHasLoggedErrors
Whether this ToolTask has logged any errors
(Inherited from ToolTask.)
Public propertyHelpCompilerFolder
This is used to pass in the path to the help compiler
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 propertyHtmlHelpName
This is used to pass in the name of the help file (no path or extension)
Public propertyLog
Gets an instance of a TaskLoggingHelper class containing task logging methods.
(Inherited from Task.)
Public propertyLogStandardErrorAsError
Should ALL messages received on the standard error stream be logged as errors.
(Inherited from ToolTask.)
Protected propertyResponseFileEncoding
Gets the Encoding of the response file.
(Inherited from ToolTask.)
Protected propertyStandardErrorEncoding
Gets the Encoding of the standard error stream of the task.
(Inherited from ToolTask.)
Public propertyStandardErrorImportance
Task Parameter: Importance with which to log text from the standard error stream.
(Inherited from ToolTask.)
Protected propertyStandardErrorImportanceToUse
Gets the actual importance at which standard error messages will be logged.
(Inherited from ToolTask.)
Protected propertyStandardErrorLoggingImportance
This is overridden to force all standard error info to be logged
(Overrides ToolTaskStandardErrorLoggingImportance.)
Protected propertyStandardOutputEncoding
Gets the Encoding of the standard output stream of the task.
(Inherited from ToolTask.)
Public propertyStandardOutputImportance
Task Parameter: Importance with which to log text from the standard out stream.
(Inherited from ToolTask.)
Protected propertyStandardOutputImportanceToUse
Gets the actual importance at which standard out messages will be logged.
(Inherited from ToolTask.)
Protected propertyStandardOutputLoggingImportance
This is overridden to force all standard output info to be logged
(Overrides ToolTaskStandardOutputLoggingImportance.)
Protected propertyTaskProcessTerminationTimeout
A timeout to wait for a task to terminate before killing it. In milliseconds.
(Inherited from ToolTask.)
Protected propertyTaskResources
Gets or sets the culture-specific resources associated with the task.
(Inherited from Task.)
Public propertyTimeout
Gets or sets the amount of time after which the task executable is terminated.
(Inherited from ToolTask.)
Protected propertyToolCanceled
Used to signal when a tool has been cancelled.
(Inherited from ToolTask.)
Public propertyToolExe
Projects may set this to override a task's ToolName. Tasks may override this to prevent that.
(Inherited from ToolTask.)
Protected propertyToolName
This read-only property returns the tool name (HXCOMP.EXE)
(Overrides ToolTaskToolName.)
Public propertyToolPath
Gets or sets the path of the executable file to run.
(Inherited from ToolTask.)
Public propertyUseCommandProcessor
Gets or sets a switch that specifies whether the tool task will create a batch file for the command-line and execute that using the command-processor, rather than executing the command directly.
(Inherited from ToolTask.)
Public propertyWorkingFolder
This is used to pass in the working folder where the files are located
Public propertyYieldDuringToolExecution
Indicates if the task will yield the node during tool execution.
(Inherited from ToolTask.)
Top
See Also