Click or drag to resize
Sandcastle Help File BuilderBuild2xHelpFile Properties

The Build2xHelpFile type exposes the following members.

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