GetTaskItemInfoAsync Method

Returns information about the task item stored in an ArcGIS Pro .esriTasks file.

Syntax

C#
Visual Basic (Declaration)

public static Task<TaskItemInfo> GetTaskItemInfoAsync( 
   string taskFile
)

Public Shared Function GetTaskItemInfoAsync( _
   ByVal taskFile As String _
) As Task(Of TaskItemInfo)

Parameters

taskFile: Full path to an .esriTasks file.

Return Value

A Task returning the TaskItemInfo of the task file opened.

Exceptions

Exception	Description
OpenTaskException	Error opening the task file. For example the taskFile is invalid.
TaskFileVersionException	Error opening the task file. The task file version is invalid.
System.InvalidOperationException	This must be called on the UI thread.

Example

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

try
{
  // retrieve the task item information
  TaskItemInfo taskItemInfo = await TaskAssistantModule.GetTaskItemInfoAsync(taskFile);

  string message = "Name : " + taskItemInfo.Name;
  message += "\r\n" + "Description : " + taskItemInfo.Description;
  message += "\r\n" + "Guid : " + taskItemInfo.Guid.ToString("B");
  message += "\r\n" + "Task Count : " + taskItemInfo.GetTasks().Count();

  ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show(message, "Task Information");
}
catch (OpenTaskException e)
{
  // exception thrown if task file doesn't exist or has incorrect format
  ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show(e.Message, "Task Information");
}
catch (TaskFileVersionException e)
{
  // exception thrown if task file does not support returning task information
  ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show(e.Message, "Task Information");
}

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

TaskAssistantModule Class
TaskAssistantModule Members