AddElement(GraphicsLayer,CIMGraphic,IEnumerable<CIMStringMap>) Method

Add a ArcGIS.Desktop.Layouts.GraphicElement based on the ArcGIS.Core.CIM.CIMGraphic. This method must be called on the MCT.Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public static GraphicElement AddElement( 
   GraphicsLayer graphicsLayer,
   CIMGraphic cimGraphic,
   IEnumerable<CIMStringMap> customProperties
)

Public Overloads Shared Function AddElement( _
   ByVal graphicsLayer As GraphicsLayer, _
   ByVal cimGraphic As CIMGraphic, _
   ByVal customProperties As IEnumerable(Of CIMStringMap) _
) As GraphicElement

Parameters

graphicsLayer
cimGraphic: The graphic to be added. Cannot be null
customProperties: Custom properties or null

Return Value

ArcGIS.Desktop.Layouts.GraphicElement

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentNullException	Value cannot be null: cimGraphic
System.InvalidOperationException	Map has reached maximum graphics count limit of 4000 elements. One or more elements cannot be created.
System.InvalidOperationException	Map has reached maximum graphics size limit of 10 MB. One or more elements cannot be created.

Remarks

A ArcGIS.Desktop.Layouts.GraphicElement is created that contains the cimGraphic. The geometry of the graphic cannot be empty or null. If the symbology is not set then a default symbology is applied.
The element will be selected after the add. o ArcGIS.Core.CIM.CIMInkGraphic is not supported
o ArcGIS.Core.CIM.CIMMultiPatchGraphic is not supported
The map view displaying the graphics layer should be initialized.
Custom properties, if provided, must be serializable to string.

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

GraphicsLayerExtensions Class
GraphicsLayerExtensions Members
Overload List