DeleteElements(IEnumerable<Element>) Method

In This Topic

Deletes the elements from a page layout. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Sub DeleteElements( _
   Optional ByVal elements As IEnumerable(Of Element) _
)

public void DeleteElements( 
   IEnumerable<Element> elements
)

Parameters

elements: The elements being removed

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 layout 'URI'

Remarks

If elements is null then all elements are deleted.
If a group element is provided in the list of elements to be deleted then the group element and all its children will be deleted.
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 deleted and not just that child)

Example

Delete Layout Elements

{
  //Note: Must be on QueuedTask.Run
  var elementsToRemove = layout.GetSelectedElements();
  layout.DeleteElements(elementsToRemove);
}

Delete an element or elements on a layout

{
  //Delete an element or elements on a layout.
  //Note: Must be on QueuedTask.Run

  //Delete a specific element on a layout
  //Find a single specific element
  Element rect = layout.FindElement("Rectangle") as Element;
  layout.DeleteElement(rect);

  //Or delete a group of elements using a filter
  layout.DeleteElements(item => item.Name.Contains("Clone"));

  //Or delete all elements on a layout
  layout.DeleteElements(item => true);
}

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