XamlDataDrivenToolTask Class

Represents the tasks generated by the Xaml task factory.

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.Build.Utilities.ToolTask
      Microsoft.Build.Tasks.Xaml.XamlDataDrivenToolTask

Namespace:  Microsoft.Build.Tasks.Xaml
Assembly:  Microsoft.Build.Tasks.v4.0 (in Microsoft.Build.Tasks.v4.0.dll)

public abstract class XamlDataDrivenToolTask : ToolTask

The XamlDataDrivenToolTask type exposes the following members.

  NameDescription
Protected methodXamlDataDrivenToolTaskInitializes an instance of a Microsoft[.Build.Tasks.Xaml.XamlDataDrivenToolTask] class.
Top

  NameDescription
Public propertyAcceptableNonZeroExitCodesGets or sets an array of non-zero codes which don't cause an error.
Protected propertyActiveToolSwitchesGets a set of active tool switches.
Public propertyActiveToolSwitchesValuesGets or sets the values of the active tool switches.
Public propertyAdditionalOptionsGets or sets any additional options specified in the project file.
Public propertyBuildEngineGets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
Public propertyBuildEngine2Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
Public propertyBuildEngine3Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
Public propertyBuildEngine4Gets the instance of the IBuildEngine4 object used by the task. (Inherited from Task.)
Public propertyCommandLineTemplateGets or sets the command line template.
Public propertyEchoOffIndicates 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 propertyEnvironmentVariablesArray 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 propertyExitCodeGets the returned exit code of the executable file. (Inherited from ToolTask.)
Protected propertyHasLoggedErrorsWhether this ToolTask has logged any errors (Inherited from ToolTask.)
Protected propertyHelpKeywordPrefixGets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
Public propertyHostObjectGets or sets the host object associated with the task. (Inherited from Task.)
Public propertyLogGets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
Public propertyLogStandardErrorAsErrorShould ALL messages received on the standard error stream be logged as errors. (Inherited from ToolTask.)
Protected propertyResponseFileEncodingGets the response file encoding. (Overrides ToolTask.ResponseFileEncoding.)
Protected propertyStandardErrorEncodingGets the Encoding of the standard error stream of the task. (Inherited from ToolTask.)
Public propertyStandardErrorImportanceTask Parameter: Importance with which to log text from the standard error stream. (Inherited from ToolTask.)
Protected propertyStandardErrorImportanceToUseGets the actual importance at which standard error messages will be logged. (Inherited from ToolTask.)
Protected propertyStandardErrorLoggingImportanceGets the MessageImportance with which to log errors. (Inherited from ToolTask.)
Protected propertyStandardOutputEncodingGets the Encoding of the standard output stream of the task. (Inherited from ToolTask.)
Public propertyStandardOutputImportanceTask Parameter: Importance with which to log text from the standard out stream. (Inherited from ToolTask.)
Protected propertyStandardOutputImportanceToUseGets the actual importance at which standard out messages will be logged. (Inherited from ToolTask.)
Protected propertyStandardOutputLoggingImportanceGets the MessageImportance with which to log errors. (Inherited from ToolTask.)
Protected propertyTaskProcessTerminationTimeoutA timeout to wait for a task to terminate before killing it. In milliseconds. (Inherited from ToolTask.)
Protected propertyTaskResourcesGets or sets the culture-specific resources associated with the task. (Inherited from Task.)
Public propertyTimeoutGets or sets the amount of time after which the task executable is terminated. (Inherited from ToolTask.)
Protected propertyToolCanceledUsed to signal when a tool has been cancelled. (Inherited from ToolTask.)
Public propertyToolExeProjects may set this to override a task's ToolName. Tasks may override this to prevent that. (Inherited from ToolTask.)
Protected propertyToolNameGets the name of the executable file to run. (Inherited from ToolTask.)
Public propertyToolPathGets or sets the path of the executable file to run. (Inherited from ToolTask.)
Public propertyUseCommandProcessorGets 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 propertyYieldDuringToolExecutionIndicates if the task will yield the node during tool execution. (Inherited from ToolTask.)
Top

  NameDescription
Public methodAddActiveSwitchToolValueAdds the value for a switch to the list of active values.
Protected methodCallHostObjectToExecuteCalls the host object to perform the work of the task. (Inherited from ToolTask.)
Public methodCancelCancels the process executing the task by asking it to close nicely, then after a short period, forcing termination. (Inherited from ToolTask.)
Public methodCreateSwitchValueCreates a switch value for the XamlDataDrivenToolTask.
Protected methodDeleteTempFileDeletes the specified temporary file. (Inherited from ToolTask.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecuteExecutes the task, then closes the event handle created. (Overrides ToolTask.Execute().)
Protected methodExecuteToolCreates a temporoary response (.rsp) file and runs the executable file. (Inherited from ToolTask.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGenerateCommandLineCommandsGenerates the command line if it is less than 32k. (Overrides ToolTask.GenerateCommandLineCommands().)
Protected methodGenerateFullPathToToolFinds the tool if ToolPath wasn't specified. (Overrides ToolTask.GenerateFullPathToTool().)
Protected methodGenerateResponseFileCommandsCreates the response file command. (Overrides ToolTask.GenerateResponseFileCommands().)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetProcessStartInfoInitializes the information required to spawn the process executing the tool. (Inherited from ToolTask.)
Protected methodGetResponseFileSwitchReturns the command line switch used by the executable file to specifiy a response (.rsp) file. (Inherited from ToolTask.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodGetWorkingDirectoryReturns the directory in which to run the executable file. (Inherited from ToolTask.)
Protected methodHandleTaskExecutionErrorsHandles the return code from the tool. (Overrides ToolTask.HandleTaskExecutionErrors().)
Protected methodInitializeHostObjectInitializes the host object of the task. (Inherited from ToolTask.)
Public methodIsPropertySetIndicates if the property is set.
Protected methodLogEventsFromTextOutputParses a single line of text to identify any errors or warnings in canonical format. (Inherited from ToolTask.)
Protected methodLogPathToToolLogs the tool name and path to all registered loggers. (Inherited from ToolTask.)
Protected methodLogToolCommandLogs the starting point of the run to all registered loggers. (Inherited from ToolTask.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadSwitchMapChecks the value a property is set to, and finds the corresponding switch.
Public methodReadSwitchMap2Checks the value of a property is set to, and finds the corresponding switch.
Public methodReplaceToolSwitchReplaces an existing switch with the specified one of the same name.
Protected methodResponseFileEscapeOverridable method to escape the content of the response file. (Inherited from ToolTask.)
Protected methodSkipTaskExecutionIndicates whether task execution should be skipped. (Inherited from ToolTask.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodValidateIntegerChecks an integer property to see if it is within a specified range.
Protected methodValidateParametersValidates the parameters. (Overrides ToolTask.ValidateParameters().)
Top

.NET Framework

Supported in: 4.6, 4.5, 4

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft