SetActivePortal Method

In This Topic

Sets the currently active portal. This will result in the ArcGIS.Desktop.Core.Events.ActivePortalChangedEvent being published. This method should be called from within a QueuedTask or System.Threading.Task unless the caller is within ArcGIS.Desktop.Framework.Contracts.ConfigurationManager.OnApplicationInitializing in which case the main thread should be used.

Syntax

Visual Basic (Declaration)
C#

Public Function SetActivePortal( _
   ByVal portalObj As ArcGISPortal _
) As Boolean

public bool SetActivePortal( 
   ArcGISPortal portalObj
)

Parameters

portalObj: The portal to be set active

Return Value

System.bool

Exceptions

Exception	Description
PortalConnectionDoesNotExistsException	This method or property must be called on a valid ArcGISPortal object. This object may have been edited or removed.
ArcGIS.Core.CalledOnWrongThreadException	Thrown when a method is called on the wrong Pro thread

Example

ArcGISPortalManager: Get a portal and Sign In, Set it Active

{
  //Find the portal to sign in with using its Uri...
  var uri = new Uri("http://myportal.esri.com/portal/", UriKind.Absolute);
  var aPortal = ArcGISPortalManager.Current.GetPortal(uri);
  if (!aPortal.IsSignedOn())
  {
    //Calling "SignIn" will trigger the OAuth popup if your credentials are
    //not cached (eg from a previous sign in in the session)
    if (portal.SignIn().success)
    {
      //Set this portal as my active portal
      ArcGISPortalManager.Current.SetActivePortal(portal);
    }
  }
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

ArcGISPortalManager Class
ArcGISPortalManager Members

Send feedback