ArcGIS Pro 2.7 API Reference Guide
AddOverlay(Geometry,CIMSymbolReference,Double) Method

ArcGIS.Desktop.Mapping Namespace > MapTool Class > AddOverlay Method : AddOverlay(Geometry,CIMSymbolReference,Double) Method
The geometry of the overlay.
The symbol to use for the overlay.
Map reference scale or -1
Add an overlay graphic to the map view.
Syntax
Protected Overloads Function AddOverlay( _
   ByVal geom As Geometry, _
   ByVal symbol As CIMSymbolReference, _
   ByVal referenceScale As Double _
) As IDisposable

Parameters

geom
The geometry of the overlay.
symbol
The symbol to use for the overlay.
referenceScale
Map reference scale or -1

Return Value

An object that when disposed will remove the overlay.
Remarks
When the tool is deactivated all overlay graphics will be removed.When the referenceScale is not equal to -1, the overlay will be created in real world units relative to the provided map reference scale (referenceScale). Otherwise, the overlay will be created in units of points. This is only supported in 2D.
Requirements

Target Platforms: Windows 10, Windows 8.1

See Also

Reference

MapTool Class
MapTool Members
Overload List