OpenTaskFileAsync(String,Guid) Method

In This Topic

Opens an ArcGIS Pro .esriTasks file. The file is added to the current project and loaded into the Tasks pane. Use the parameter to specify a particular task in the task file to be opened. Use the GetTaskItemInfoAsync API call to obtain information about the tasks and their identifiers within the task file.

Syntax

C#
Visual Basic (Declaration)

public Task<Guid> OpenTaskFileAsync( 
   string taskFile,
   Guid taskGuid
)

Public Overloads Function OpenTaskFileAsync( _
   ByVal taskFile As String, _
   ByVal taskGuid As Guid _
) As Task(Of Guid)

Parameters

taskFile: Full path to an .esriTasks file.
taskGuid: The unique identifier of a task in the task file to be opened. If the task can be found, it is opened and ready to be executed. If the task cannot be found, the task file opens as if no task was specified.

Return Value

A Task returning the unique identifier of the task file opened. Use this unique identifier as parameters to other API calls such as CloseTaskItemAsync or ExportTaskItemAsync.

Exceptions

Exception	Description
ArcGIS.Desktop.TaskAssistant.Exceptions.OpenTaskException	Error opening the task file. For example the taskFile is invalid or the Tasks pane is in Designer mode and editing another task item.
System.InvalidOperationException	This must be called on the UI thread.

Remarks

If the Tasks pane is not already visible, it will be opened. If the Tasks pane is visible, any current task item will be unloaded to allow the new item to be loaded.

If the Tasks pane is in Designer mode; then an ArcGIS.Desktop.TaskAssistant.Exceptions.OpenTaskException will be thrown. Task files can only be opened if the Tasks pane is not in Designer mode.

Example

Open a specific Task in a Task File - .esriTasks file

// TODO - substitute your own .esriTasks file to be opened
string taskFile = @"c:\Tasks\Get Started.esriTasks";

await QueuedTask.Run(async () =>
{
  try
  {
    // retrieve the task item information
    //At 2.x -
    //TaskItemInfo taskItemInfo = await TaskAssistantModule.GetTaskItemInfoAsync(taskFile);
    var taskItemInfo = await TaskAssistantFactory.Instance.GetTaskItemInfoAsync(taskFile);

    // find the first task
    TaskInfo taskInfo = taskItemInfo.GetTasks().FirstOrDefault();

    Guid guid = Guid.Empty;
    if (taskInfo != null)
    {
      // if a task exists, open it
      //At 2.x -
      //guid = await TaskAssistantModule.OpenTaskAsync(taskFile, taskInfo.Guid);
      guid = await TaskAssistantFactory.Instance.OpenTaskFileAsync(taskFile, taskInfo.Guid);
    }
    else
    {
      // else just open the task item
      //At 2.x -
      //guid = await TaskAssistantModule.OpenTaskAsync(taskFile);
      guid = await TaskAssistantFactory.Instance.OpenTaskFileAsync(taskFile);
    }

    // TODO - retain the guid returned for use with CloseTaskItemAsync 
  }
  catch (OpenTaskException e)
  {
    // exception thrown if task file doesn't exist or has incorrect format
    ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show(e.Message);
  }
  catch (TaskFileVersionException e)
  {
    // exception thrown if task file does not support returning task information
    ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show(e.Message);
  }

});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

TaskAssistantFactory Class
TaskAssistantFactory Members
Overload List

Send feedback