Subscribe Method (GPExecuteToolEvent)

In This Topic

Subscribe to the GPExecuteToolEvent.

Syntax

Visual Basic (Declaration)
C#

Public Shared Function Subscribe( _
   ByVal action As Action(Of GPExecuteToolEventArgs), _
   Optional ByVal keepSubscriberAlive As Boolean _
) As SubscriptionToken

public static SubscriptionToken Subscribe( 
   Action<GPExecuteToolEventArgs> action,
   bool keepSubscriberAlive
)

Parameters

action: The delegate to be executed when the event is published.
keepSubscriberAlive: When false the ArcGIS.Core.Events.CompositePresentationEvent<TPayload> will maintain a weak delegate reference to the subscriber. Using a weak delegate reference relieves the subscriber from the need to unsubscribe to enable proper garbage collection.

Return Value

A ArcGIS.Core.Events.SubscriptionToken that uniquely identifies the added subscription.

Example

How to use Geoprocessing public event

{
  ArcGIS.Desktop.Core.Events.GPExecuteToolEvent.Subscribe(e =>
        {
          // Handle the event
          string id = e.ID;           // Same as history ID
          if (e.IsStarting == false)  // Execute completed
            _ = e.GPResult.ReturnValue;
          System.Windows.MessageBox.Show("event triggered.");
        });
  Geoprocessing.ExecuteToolAsync("management.GetCount", Geoprocessing.MakeValueArray(@"c:\shape_file.shp"));
}

Requirements

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

ArcGIS Pro version: 3.1 or higher.

Reference

GPExecuteToolEvent Class
GPExecuteToolEvent Members

Send feedback