XamlDataDrivenToolTask XamlDataDrivenToolTask XamlDataDrivenToolTask XamlDataDrivenToolTask Class

Definition

Represents the tasks generated by the Xaml task factory.

public ref class XamlDataDrivenToolTask abstract : Microsoft::Build::Utilities::ToolTask
public abstract class XamlDataDrivenToolTask : Microsoft.Build.Utilities.ToolTask
type XamlDataDrivenToolTask = class
    inherit ToolTask
Public MustInherit Class XamlDataDrivenToolTask
Inherits ToolTask
Inheritance
XamlDataDrivenToolTaskXamlDataDrivenToolTaskXamlDataDrivenToolTaskXamlDataDrivenToolTask

Constructors

XamlDataDrivenToolTask(String[], ResourceManager) XamlDataDrivenToolTask(String[], ResourceManager) XamlDataDrivenToolTask(String[], ResourceManager) XamlDataDrivenToolTask(String[], ResourceManager)

Initializes an instance of a XamlDataDrivenToolTask class.

Properties

AcceptableNonZeroExitCodes AcceptableNonZeroExitCodes AcceptableNonZeroExitCodes AcceptableNonZeroExitCodes

Gets or sets an array of non-zero codes which don't cause an error.

ActiveToolSwitches ActiveToolSwitches ActiveToolSwitches ActiveToolSwitches

Gets a set of active tool switches.

ActiveToolSwitchesValues ActiveToolSwitchesValues ActiveToolSwitchesValues ActiveToolSwitchesValues

Gets or sets the values of the active tool switches.

AdditionalOptions AdditionalOptions AdditionalOptions AdditionalOptions

Gets or sets any additional options specified in the project file.

BuildEngine BuildEngine BuildEngine BuildEngine

Gets or sets the instance of the IBuildEngine object used by the task.

(Inherited from Task)
BuildEngine2 BuildEngine2 BuildEngine2 BuildEngine2

Gets the instance of the IBuildEngine2 object used by the task.

(Inherited from Task)
BuildEngine3 BuildEngine3 BuildEngine3 BuildEngine3

Gets the instance of the IBuildEngine3 object used by the task.

(Inherited from Task)
BuildEngine4 BuildEngine4 BuildEngine4 BuildEngine4

Gets the instance of the IBuildEngine4 object used by the task.

(Inherited from Task)
CommandLineTemplate CommandLineTemplate CommandLineTemplate CommandLineTemplate

Gets or sets the command line template.

EchoOff EchoOff EchoOff EchoOff

Gets or sets a value that indicates whether command line echoing is turned off.

(Inherited from ToolTask)
EnvironmentOverride EnvironmentOverride EnvironmentOverride EnvironmentOverride

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)
EnvironmentVariables EnvironmentVariables EnvironmentVariables 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)
ExitCode ExitCode ExitCode ExitCode

Gets the returned exit code of the executable file.

(Inherited from ToolTask)
HasLoggedErrors HasLoggedErrors HasLoggedErrors HasLoggedErrors

Whether this ToolTask has logged any errors

(Inherited from ToolTask)
HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix HelpKeywordPrefix

Gets or sets the prefix used to compose Help keywords from resource names.

(Inherited from Task)
HostObject HostObject HostObject HostObject

Gets or sets the host object associated with the task.

(Inherited from Task)
Log Log Log Log

Gets an instance of a TaskLoggingHelper class containing task logging methods.

(Inherited from Task)
LogStandardErrorAsError LogStandardErrorAsError LogStandardErrorAsError LogStandardErrorAsError

Should ALL messages received on the standard error stream be logged as errors.

(Inherited from ToolTask)
ResponseFileEncoding ResponseFileEncoding ResponseFileEncoding ResponseFileEncoding

Gets the response file encoding.

StandardErrorEncoding StandardErrorEncoding StandardErrorEncoding StandardErrorEncoding

Gets the Encoding of the standard error stream of the task.

(Inherited from ToolTask)
StandardErrorImportance StandardErrorImportance StandardErrorImportance StandardErrorImportance

Task Parameter: Importance with which to log text from the standard error stream.

(Inherited from ToolTask)
StandardErrorImportanceToUse StandardErrorImportanceToUse StandardErrorImportanceToUse StandardErrorImportanceToUse

Gets the actual importance at which standard error messages will be logged.

(Inherited from ToolTask)
StandardErrorLoggingImportance StandardErrorLoggingImportance StandardErrorLoggingImportance StandardErrorLoggingImportance

Gets the MessageImportance with which to log errors.

(Inherited from ToolTask)
StandardOutputEncoding StandardOutputEncoding StandardOutputEncoding StandardOutputEncoding

Gets the Encoding of the standard output stream of the task.

(Inherited from ToolTask)
StandardOutputImportance StandardOutputImportance StandardOutputImportance StandardOutputImportance

Task Parameter: Importance with which to log text from the standard out stream.

(Inherited from ToolTask)
StandardOutputImportanceToUse StandardOutputImportanceToUse StandardOutputImportanceToUse StandardOutputImportanceToUse

Gets the actual importance at which standard out messages will be logged.

(Inherited from ToolTask)
StandardOutputLoggingImportance StandardOutputLoggingImportance StandardOutputLoggingImportance StandardOutputLoggingImportance

Gets the MessageImportance with which to log errors.

(Inherited from ToolTask)
TaskProcessTerminationTimeout TaskProcessTerminationTimeout TaskProcessTerminationTimeout TaskProcessTerminationTimeout

A timeout to wait for a task to terminate before killing it. In milliseconds.

(Inherited from ToolTask)
TaskResources TaskResources TaskResources TaskResources

Gets or sets the culture-specific resources associated with the task.

(Inherited from Task)
Timeout Timeout Timeout Timeout

Gets or sets the amount of time after which the task executable is terminated.

(Inherited from ToolTask)
ToolCanceled ToolCanceled ToolCanceled ToolCanceled

Used to signal when a tool has been cancelled.

(Inherited from ToolTask)
ToolExe ToolExe ToolExe ToolExe

Projects may set this to override a task's ToolName. Tasks may override this to prevent that.

(Inherited from ToolTask)
ToolName ToolName ToolName ToolName

Gets the name of the executable file to run.

(Inherited from ToolTask)
ToolPath ToolPath ToolPath ToolPath

Gets or sets the path of the executable file to run.

(Inherited from ToolTask)
UseCommandProcessor UseCommandProcessor UseCommandProcessor UseCommandProcessor

Gets or sets a value that indicates 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)
YieldDuringToolExecution YieldDuringToolExecution YieldDuringToolExecution YieldDuringToolExecution

Gets or sets a value that indicates whether the task will yield the node during tool execution.

(Inherited from ToolTask)

Methods

AddActiveSwitchToolValue(CommandLineToolSwitch) AddActiveSwitchToolValue(CommandLineToolSwitch) AddActiveSwitchToolValue(CommandLineToolSwitch) AddActiveSwitchToolValue(CommandLineToolSwitch)

Adds the value for a switch to the list of active values.

CallHostObjectToExecute() CallHostObjectToExecute() CallHostObjectToExecute() CallHostObjectToExecute()

Calls the host object to perform the work of the task.

(Inherited from ToolTask)
Cancel() Cancel() Cancel() Cancel()

Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.

(Inherited from ToolTask)
CreateSwitchValue(String, String, String, Tuple<String,Boolean>[]) CreateSwitchValue(String, String, String, Tuple<String,Boolean>[]) CreateSwitchValue(String, String, String, Tuple<String,Boolean>[]) CreateSwitchValue(String, String, String, Tuple<String,Boolean>[])

Creates a switch value for the XamlDataDrivenToolTask.

DeleteTempFile(String) DeleteTempFile(String) DeleteTempFile(String) DeleteTempFile(String)

Deletes the specified temporary file.

(Inherited from ToolTask)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute() Execute() Execute() Execute()

Executes the task, then closes the event handle created.

ExecuteTool(String, String, String) ExecuteTool(String, String, String) ExecuteTool(String, String, String) ExecuteTool(String, String, String)

Creates a temporary response (.rsp) file and runs the executable file.

(Inherited from ToolTask)
GenerateCommandLineCommands() GenerateCommandLineCommands() GenerateCommandLineCommands() GenerateCommandLineCommands()

Generates the command line if it is less than 32k.

GenerateFullPathToTool() GenerateFullPathToTool() GenerateFullPathToTool() GenerateFullPathToTool()

Finds the tool if ToolPath wasn't specified.

GenerateResponseFileCommands() GenerateResponseFileCommands() GenerateResponseFileCommands() GenerateResponseFileCommands()

Creates the response file command.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetProcessStartInfo(String, String, String) GetProcessStartInfo(String, String, String) GetProcessStartInfo(String, String, String) GetProcessStartInfo(String, String, String)

Initializes the information required to spawn the process executing the tool.

(Inherited from ToolTask)
GetResponseFileSwitch(String) GetResponseFileSwitch(String) GetResponseFileSwitch(String) GetResponseFileSwitch(String)

Returns the command line switch used by the executable file to specify a response (.rsp) file.

(Inherited from ToolTask)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetWorkingDirectory() GetWorkingDirectory() GetWorkingDirectory() GetWorkingDirectory()

Returns the directory in which to run the executable file.

(Inherited from ToolTask)
HandleTaskExecutionErrors() HandleTaskExecutionErrors() HandleTaskExecutionErrors() HandleTaskExecutionErrors()

Handles the return code from the tool.

InitializeHostObject() InitializeHostObject() InitializeHostObject() InitializeHostObject()

Initializes the host object of the task.

(Inherited from ToolTask)
IsPropertySet(String) IsPropertySet(String) IsPropertySet(String) IsPropertySet(String)

Indicates if the property is set.

LogEventsFromTextOutput(String, MessageImportance) LogEventsFromTextOutput(String, MessageImportance) LogEventsFromTextOutput(String, MessageImportance) LogEventsFromTextOutput(String, MessageImportance)

Parses a single line of text to identify any errors or warnings in canonical format.

(Inherited from ToolTask)
LogPathToTool(String, String) LogPathToTool(String, String) LogPathToTool(String, String) LogPathToTool(String, String)

Logs the tool name and path to all registered loggers.

(Inherited from ToolTask)
LogToolCommand(String) LogToolCommand(String) LogToolCommand(String) LogToolCommand(String)

Logs the starting point of the run to all registered loggers.

(Inherited from ToolTask)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ReadSwitchMap(String, String[][], String) ReadSwitchMap(String, String[][], String) ReadSwitchMap(String, String[][], String) ReadSwitchMap(String, String[][], String)

Checks the value a property is set to, and finds the corresponding switch.

ReadSwitchMap2(String, Tuple<String,String,Tuple<String,Boolean>[]>[], String) ReadSwitchMap2(String, Tuple<String,String,Tuple<String,Boolean>[]>[], String) ReadSwitchMap2(String, Tuple<String,String,Tuple<String,Boolean>[]>[], String) ReadSwitchMap2(String, Tuple<String,String,Tuple<String,Boolean>[]>[], String)

Checks the value of a property is set to, and finds the corresponding switch.

ReplaceToolSwitch(CommandLineToolSwitch) ReplaceToolSwitch(CommandLineToolSwitch) ReplaceToolSwitch(CommandLineToolSwitch) ReplaceToolSwitch(CommandLineToolSwitch)

Replaces an existing switch with the specified one of the same name.

ResponseFileEscape(String) ResponseFileEscape(String) ResponseFileEscape(String) ResponseFileEscape(String)

Overridable method to escape the content of the response file.

(Inherited from ToolTask)
SkipTaskExecution() SkipTaskExecution() SkipTaskExecution() SkipTaskExecution()

Indicates whether task execution should be skipped.

(Inherited from ToolTask)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
ValidateInteger(String, Int32, Int32, Int32) ValidateInteger(String, Int32, Int32, Int32) ValidateInteger(String, Int32, Int32, Int32) ValidateInteger(String, Int32, Int32, Int32)

Checks an integer property to see if it is within a specified range.

ValidateParameters() ValidateParameters() ValidateParameters() ValidateParameters()

Validates the parameters.

Applies to