GroupElements Method (Layout)

In This Topic

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

Syntax

Visual Basic (Declaration)
C#

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

public GroupElement GroupElements( 
   IEnumerable<Element> elements
)

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

{
  //Note: Must be on QueuedTask.Run
  var elemsToGroup = layout.GetSelectedElements();
  //Note: run within the QueuedTask
  //group  elements
  var newGroupElement = layout.GroupElements(elemsToGroup);
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

Layout Class
Layout Members

Send feedback