SetDeviceLocationEnabled Method (MapDeviceLocationService)

In This Topic

Enables (or disables) the current DeviceLocationSource. Use ArcGIS.Desktop.Core.DeviceLocation.IDeviceLocationService.Open prior to enabling the DeviceLocationSource. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SetDeviceLocationEnabled( 
   bool enable
)

Public Sub SetDeviceLocationEnabled( _
   ByVal enable As Boolean _
)

Parameters

enable: Set to true to enable the current DeviceLocationSource. False to disable.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.InvalidOperationException	The active map view is null.
System.InvalidOperationException	A DeviceLocationSource must be open.

Remarks

There must be an active map view with an associated map or an System.InvalidOperationException will be thrown.

Set MapDeviceLocationOptions.DeviceLocationVisibility = true to display the location on the map view when the device location source is enabled. Refer to SetDeviceLocationOptions.

Example

Enable/Disable Current Device Location Source For the Map

bool enabled = MapDeviceLocationService.Instance.IsDeviceLocationEnabled;

await QueuedTask.Run(() =>
{
  MapDeviceLocationService.Instance.SetDeviceLocationEnabled(!enabled);
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

MapDeviceLocationService Class
MapDeviceLocationService Members

Send feedback