This topic has not yet been rated - Rate this topic

XamlDataDrivenToolTask Class

Class for 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.

  Name Description
Protected method XamlDataDrivenToolTask Initializes an instance of a Microsoft[.Build.Tasks.Xaml.XamlDataDrivenToolTask] class.
Top
  Name Description
Public property AcceptableNonZeroExitCodes Contains an array of non-zero codes which don't cause an error.
Protected property ActiveToolSwitches Contains a set of active tool switches.
Public property ActiveToolSwitchesValues Contains the values of the active tool switches.
Public property AdditionalOptions Contains any additional specified in the project file.
Public property BuildEngine Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
Public property BuildEngine2 Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
Public property BuildEngine3 Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
Public property CommandLineTemplate Contains the command line template.
Public property EchoOff Indicates that command line echoing is turned off. (Inherited from ToolTask.)
Protected property EnvironmentOverride 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 property EnvironmentVariables 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 property ExitCode Gets the returned exit code of the executable file. (Inherited from ToolTask.)
Protected property HasLoggedErrors Whether this ToolTask has logged any errors (Inherited from ToolTask.)
Protected property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
Public property HostObject Gets or sets the host object associated with the task. (Inherited from Task.)
Public property Log Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
Public property LogStandardErrorAsError Should ALL messages received on the standard error stream be logged as errors. (Inherited from ToolTask.)
Protected property ResponseFileEncoding Contains the response file encoding. (Overrides ToolTask.ResponseFileEncoding.)
Protected property StandardErrorEncoding Gets the Encoding of the standard error stream of the task. (Inherited from ToolTask.)
Public property StandardErrorImportance Task Parameter: Importance with which to log text from the standard error stream. (Inherited from ToolTask.)
Protected property StandardErrorImportanceToUse Gets the actual importance at which standard error messages will be logged. (Inherited from ToolTask.)
Protected property StandardErrorLoggingImportance Gets the MessageImportance with which to log errors. (Inherited from ToolTask.)
Protected property StandardOutputEncoding Gets the Encoding of the standard output stream of the task. (Inherited from ToolTask.)
Public property StandardOutputImportance Task Parameter: Importance with which to log text from the standard out stream. (Inherited from ToolTask.)
Protected property StandardOutputImportanceToUse Gets the actual importance at which standard out messages will be logged. (Inherited from ToolTask.)
Protected property StandardOutputLoggingImportance Gets the MessageImportance with which to log errors. (Inherited from ToolTask.)
Protected property TaskProcessTerminationTimeout A timeout to wait for a task to terminate before killing it. In milliseconds. (Inherited from ToolTask.)
Protected property TaskResources Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)
Public property Timeout Gets or sets the amount of time after which the task executable is terminated. (Inherited from ToolTask.)
Protected property ToolCanceled Used to signal when a tool has been cancelled. (Inherited from ToolTask.)
Public property ToolExe Projects may set this to override a task's ToolName. Tasks may override this to prevent that. (Inherited from ToolTask.)
Protected property ToolName Gets the name of the executable file to run. (Inherited from ToolTask.)
Public property ToolPath Gets or sets the path of the executable file to run. (Inherited from ToolTask.)
Public property UseCommandProcessor 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 property YieldDuringToolExecution Indicates if the task will yield the node during tool execution. (Inherited from ToolTask.)
Top
  Name Description
Public method AddActiveSwitchToolValue Adds the value for a switch to the list of active values.
Protected method CallHostObjectToExecute Calls the host object to perform the work of the task. (Inherited from ToolTask.)
Public method Cancel Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination. (Inherited from ToolTask.)
Protected method DeleteTempFile Deletes the specified temporary file. (Inherited from ToolTask.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method Execute Executes the task, then closes the event handle created. (Overrides ToolTask.Execute().)
Protected method ExecuteTool Creates a temporoary response (.rsp) file and runs the executable file. (Inherited from ToolTask.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GenerateCommandLineCommands Generates the command line if it is less than 32k. (Overrides ToolTask.GenerateCommandLineCommands().)
Protected method GenerateFullPathToTool Finds the tool if ToolPath wasn't specified. (Overrides ToolTask.GenerateFullPathToTool().)
Protected method GenerateResponseFileCommands Creates the command line. (Overrides ToolTask.GenerateResponseFileCommands().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetProcessStartInfo Initializes the information required to spawn the process executing the tool. (Inherited from ToolTask.)
Protected method GetResponseFileSwitch Returns the command line switch used by the executable file to specifiy a response (.rsp) file. (Inherited from ToolTask.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method GetWorkingDirectory Returns the directory in which to run the executable file. (Inherited from ToolTask.)
Protected method HandleTaskExecutionErrors Handles the return code from the tool. (Overrides ToolTask.HandleTaskExecutionErrors().)
Protected method InitializeHostObject Initializes the host object of the task. (Inherited from ToolTask.)
Public method IsPropertySet Indicates if the property is set.
Protected method LogEventsFromTextOutput Parses a single line of text to identify any errors or warnings in canonical format. (Inherited from ToolTask.)
Protected method LogPathToTool Logs the tool name and path to all registered loggers. (Inherited from ToolTask.)
Protected method LogToolCommand Logs the starting point of the run to all registered loggers. (Inherited from ToolTask.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ReadSwitchMap Checks the value a property is set to, and finds the corresponding switch.
Public method ReplaceToolSwitch Replaces an existing switch with the specified one of the same name.
Protected method SkipTaskExecution Indicates whether task execution should be skipped. (Inherited from ToolTask.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method ValidateInteger Checks an integer property to see if it is within a specified range.
Protected method ValidateParameters Validates the parameters. (Overrides ToolTask.ValidateParameters().)
Top

.NET Framework

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ