AddOverlay(Layer,Int64,CIMSymbolReference,Double) Method

In This Topic

Add an overlay graphic for a feature on the map view.

Syntax

C#
Visual Basic (Declaration)

protected IDisposable AddOverlay( 
   Layer layer,
   long oid,
   CIMSymbolReference symbol,
   double referenceScale
)

Protected Overloads Function AddOverlay( _
   ByVal layer As Layer, _
   ByVal oid As Long, _
   Optional ByVal symbol As CIMSymbolReference, _
   Optional ByVal referenceScale As Double _
) As IDisposable

Parameters

layer: The layer containing the feature.
oid: The ObjectID for the feature.
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.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

MapTool Class
MapTool Members
Overload List

Send feedback