DeleteElements Method (Report)

In This Topic

Deletes the set of elements from the report. Note that section elements cannot be deleted and will be ignored if specified. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

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

public void DeleteElements( 
   IEnumerable<Element> elements
)

Parameters

elements: The set of elements to be deleted.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentNullException	The value cannot be null: elements

Remarks

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 Elements

{
  //Note: Needs QueuedTask to run
  var reportElementsToFind = new List<string> { "ReportText1", "ReportText2" };
  var textReportElements = report.FindElements(reportElementsToFind);
  report.DeleteElements(textReportElements);
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

Report Class
Report Members

Send feedback