Click or drag to resize
Sandcastle Help File BuilderBuild1xHelpFile Methods

The Build1xHelpFile type exposes the following members.

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 invert the result returned from the help compiler.
(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 HHC 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
See Also