SetGroundToGridCorrection Method

In This Topic

Sets the GroundToGridCorrection for the given map.

Syntax

C#
Visual Basic (Declaration)

public static Task<bool> SetGroundToGridCorrection( 
   Map map,
   CIMGroundToGridCorrection correction
)

Public Shared Function SetGroundToGridCorrection( _
   ByVal map As Map, _
   ByVal correction As CIMGroundToGridCorrection _
) As Task(Of Boolean)

Parameters

map: The ArcGIS.Desktop.Mapping.Map that will have its GroundToGridCorrection set.
correction: The ArcGIS.Core.CIM.CIMGroundToGridCorrection that will be set.

Return Value

A Task returning true when a change has been made, and false when no change has been made.

Exceptions

Exception	Description
System.ArgumentNullException	map is null or correction is null.

Remarks

This extension method for the ArcGIS.Desktop.Mapping.Map class automatically switches to the correct thread to set the property. The map will not refresh after making the change. Calling code can listen to ArcGIS.Desktop.Editing.Events.GroundToGridEvent to be notified when a change is completed. An event is published when the new correction differs from the existing correction.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

GroundToGridCorrection Class
GroundToGridCorrection Members

Send feedback