SetCurrentToolAsync Method

In This Topic

Activates the specified tool.

Syntax

Visual Basic (Declaration)
C#

Public Shared Function SetCurrentToolAsync( _
   ByVal id As String _
) As Task

public static Task SetCurrentToolAsync( 
   string id
)

Parameters

id: The tool's DAML identifier.

Return Value

Returns an awaitable task which, when complete, indicates the tool is fully initialized and ready for use.

Remarks

Setting the application's current tool is asynchronous as tools often need to initialize themselves on the primary worker thread before they are ready for use.

Example

Set the current tool

{
  // use SetCurrentToolAsync with await
  FrameworkApplication.SetCurrentToolAsync("esri_mapping_selectByRectangleTool").Wait();

  // or use ICommand.Execute
  if (FrameworkApplication.GetPlugInWrapper("esri_mapping_selectByRectangleTool") is ICommand cmd && cmd.CanExecute(null))
    cmd.Execute(null);
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

FrameworkApplication Class
FrameworkApplication Members

Send feedback