Clone Method (GraphicElement)

In This Topic

Generates a cloned copy of an existing GraphicElement on a page layout. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Function Clone( _
   Optional ByVal suffix As String _
) As GraphicElement

public GraphicElement Clone( 
   string suffix
)

Parameters

suffix: String

Return Value

GraphicElement

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method must be called within the lambda passed to QueuedTask.Run.
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

The suffix parameter is an optional string that is used to tag each newly created GraphicElement. The new element will get the same element name as the parent graphic plus the suffix value along with a numeric sequencer. This makes it possible, if needed, to find and remove unwanted cloned items.

Example

Clone an element

{
  //Clone a layout graphic element and apply an offset.
  //Note: Must be on QueuedTask.Run

  // Reference a graphic element by name
  GraphicElement graphicElement =
                      layout.FindElement("MyElement") as GraphicElement;
  if (graphicElement != null)
  {

    //Clone and set the new x,y
    GraphicElement cloneElement = graphicElement.Clone("Clone");
    double xOffset = 0;
    double yOffset = 0;
    cloneElement.SetX(cloneElement.GetX() + xOffset);
    cloneElement.SetY(cloneElement.GetY() + yOffset);
  }
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

GraphicElement Class
GraphicElement Members

Send feedback