Subscribe Method (ActiveTemplateChangedEvent)

In This Topic

Subscribes to the ActiveTemplateChangedEvent.

Syntax

Visual Basic (Declaration)
C#

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

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

Parameters

action: A delegate that is executed when the ActiveTemplateChangedEvent is published.
keepSubscriberAlive: (optional) The type of reference used to maintain the delegate. false is a weak reference, true is a strong reference. (default value = false)

Return Value

A token that uniquely identifies the added subscription, and may subsequently be used with Unsubscribe.

Example

Active Template Changed

// Subscribes to the active template changed event and handles changes to the editing template.
ArcGIS.Desktop.Editing.Events.ActiveTemplateChangedEvent.Subscribe(async activeTemplateChangedEventArgs
  =>
{
  // return if incoming template is null
  if (activeTemplateChangedEventArgs.IncomingTemplate == null)
    return;

  // Activate two-point line tool for Freeway template in the Layers map
  if (activeTemplateChangedEventArgs.IncomingTemplate.Name == "Freeway" && activeTemplateChangedEventArgs.IncomingMapView.Map.Name == "Layers")
    await activeTemplateChangedEventArgs.IncomingTemplate.ActivateToolAsync("esri_editing_SketchTwoPointLineTool");
});

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

ActiveTemplateChangedEvent Class
ActiveTemplateChangedEvent Members

Send feedback