| IProjectRunAutomaticTask Method (Guid, String, EventHandlerTaskStatusEventArgs, EventHandlerTaskMessageEventArgs) |
Runs an automatic task on a set of files.
Automatic task template IDs are defined in
AutomaticTaskTemplateIds.
This overload allows event handlers to be specified for task status and message events.
These events support cancellation of the task.
Namespace: Sdl.ProjectAutomation.CoreAssembly: Sdl.ProjectAutomation.Core (in Sdl.ProjectAutomation.Core.dll) Version: 3.0.0.0 (3.1.5799.0)
SyntaxAutomaticTask RunAutomaticTask(
Guid[] projectFileIds,
string taskTemplateId,
EventHandler<TaskStatusEventArgs> statusEventHandler,
EventHandler<TaskMessageEventArgs> messageEventHandler
)
Function RunAutomaticTask (
projectFileIds As Guid(),
taskTemplateId As String,
statusEventHandler As EventHandler(Of TaskStatusEventArgs),
messageEventHandler As EventHandler(Of TaskMessageEventArgs)
) As AutomaticTask
AutomaticTask^ RunAutomaticTask(
array<Guid>^ projectFileIds,
String^ taskTemplateId,
EventHandler<TaskStatusEventArgs^>^ statusEventHandler,
EventHandler<TaskMessageEventArgs^>^ messageEventHandler
)
abstract RunAutomaticTask :
projectFileIds : Guid[] *
taskTemplateId : string *
statusEventHandler : EventHandler<TaskStatusEventArgs> *
messageEventHandler : EventHandler<TaskMessageEventArgs> -> AutomaticTask
Parameters
- projectFileIds
- Type: SystemGuid
The files to run the task on. - taskTemplateId
- Type: SystemString
The ID of the task template (i.e. the type of task) to run. - statusEventHandler
- Type: SystemEventHandlerTaskStatusEventArgs
Event handler for task status events. - messageEventHandler
- Type: SystemEventHandlerTaskMessageEventArgs
Event handler for message events.
Return Value
Type:
AutomaticTaskInformation about the automatic task that has been run.
RemarksMultiple automatic tasks can be run together in a sequence using FileBasedProject.RunAutomaticTasks
See Also
Comments