FormatLocation(Double,Double,SpatialReference) Method

In This Topic

Format the input location using the location unit format. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Function FormatLocation( _
   ByVal x As Double, _
   ByVal y As Double, _
   Optional ByVal sr As SpatialReference _
) As String

public string FormatLocation( 
   double x,
   double y,
   SpatialReference sr
)

Parameters

x: The x coordinate
y: The y coordinate
sr: The spatial reference. WGS84 is assumed if sr is null

Return Value

A formatted location string

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run

Remarks

The UnitFormatType must be of type UnitFormatType.Location or an empty string will be returned.
If either of x or y is double.NaN an empty string will be returned.
If the spatial reference is null then WGS84 is assumed.

Example

Format a Location Using the Current Map Location Unit

{
    //Get the current view camera location
    var center_pt = new Coordinate2D(mapView.Camera.X, mapView.Camera.Y);
    //Get the current location unit
    //Note: Must be on the QueuedTask.Run()
    var loc_unit = map.GetLocationUnitFormat();

    //Format the camera location
    var str = loc_unit.FormatLocation(center_pt, map.SpatialReference);
    System.Diagnostics.Debug.WriteLine($"Formatted location: {str}");
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

DisplayUnitFormat Class
DisplayUnitFormat Members
Overload List

Send feedback