Subscribe Method (ActivePortalChangedEvent)

In This Topic

Subscribe to the ActivePortalChangedEvent.

Syntax

C#
Visual Basic (Declaration)

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

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

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

ArcGISPortalManager: Listen for the Portal Events

ArcGIS.Desktop.Core.Events.ActivePortalChangedEvent.Subscribe((args) =>
{

  var active_uri = args.ActivePortal?.PortalUri.ToString();
  //etc
});

ArcGIS.Desktop.Core.Events.ArcGISPortalAddedEvent.Subscribe((args) =>
{
  var added_portal = args.Portal;
  //etc
});

ArcGIS.Desktop.Core.Events.ArcGISPortalRemovedEvent.Subscribe((args) =>
{
  var old_uri = args.RemovedPortalUri;
  //etc
});

ArcGIS.Desktop.Core.Events.PortalSignOnChangedEvent.Subscribe((args) =>
{
  var portal = args.Portal;
  var isSignedOn = args.IsSignedOn;
  //etc
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

ActivePortalChangedEvent Class
ActivePortalChangedEvent Members

Send feedback