CopyElements(GroupElement,IEnumerable<Element>) Method

In This Topic

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

Syntax

C#
Visual Basic (Declaration)

public IReadOnlyList<Element> CopyElements( 
   GroupElement group,
   IEnumerable<Element> elements
)

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

Parameters

group: A group element within the page layout
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 source layout 'URI'
System.ArgumentException	group element must belong to target layout 'URI'

Remarks

The group element must belong to the graphics layer into which the elements are being copied. Only elements from a single page layout can be copied at one time. To copy elements from multiple page layouts, CopyElements must be called for each layout.
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

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

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Layout Class
Layout Members
Overload List

Send feedback