CopyElements(IEnumerable<Element>) Method

In This Topic

Copy the elements into the page layout. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Function CopyElements( _
   ByVal elements As IEnumerable(Of Element) _
) As IReadOnlyList(Of Element)

public IReadOnlyList<Element> CopyElements( 
   IEnumerable<Element> elements
)

Parameters

elements: The elements to be copied

Return Value

IReadOnlyList

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	elements must belong to a layout
System.ArgumentException	elements must belong to layout 'URI'

Remarks

Only elements from a single page layout can be copied at one time. To copy elements from page layouts, CopyElements must be called each time.
If a group element is provided in the list of elements to be copied then the group element and all its children will be copied.
If a child of a group element is provided in the list in addition to its parent then the parent takes precedence (i.e. the entire group element is copied and not just that child).
If a child element of a group element is provided in the list but its parent is not then only the child element is copied. The parent of the copied element will become the target group element.

Example

Copy Layout Elements

{
  //Note: Must be on QueuedTask.Run
  var elems = layout.FindElements(new List<string>() { "Point 1", "Line 3", "Text 1" });
  var copiedElements = layout.CopyElements(elems);
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

Layout Class
Layout Members
Overload List

Send feedback