GroupElements Method (Layout)

In This Topic

Group the collection of elements. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public GroupElement GroupElements( 
   IEnumerable<Element> elements
)

Public Function GroupElements( _
   ByVal elements As IEnumerable(Of Element) _
) As GroupElement

Parameters

elements: The elements to be grouped.

Return Value

GroupElement containing the grouped elements

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	elements cannot be null or empty
System.ArgumentException	elements must belong to layout 'URI'
System.ArgumentException	element parents must be the same and non-null

Remarks

If any group elements are present in the input collection, they must have the same parent or a element parents must be the same and non-null will be thrown.

Example

Group Graphic Elements

//on the QueuedTask
var elemsToGroup = layout.GetSelectedElements();
//Note: run within the QueuedTask
//group  elements
var groupElement = layout.GroupElements(elemsToGroup);

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Layout Class
Layout Members

Send feedback