SendToBack(IEnumerable<Element>) Method

In This Topic

Send the elements to the back of their parent's element collection. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SendToBack( 
   IEnumerable<Element> elements
)

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

Parameters

elements: The elements to send to the back

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

Refer to CanSendBackward(IEnumerable<Element>) to check whether the elements can be sent back. Element z order can only be changed relative to their parent's element collection. All elements must have the same parent. The bottom element will have a z order of 0 within the element parent's element collection. Check individual element z order with Element.ZOrder.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

Layout Class
Layout Members
Overload List

Send feedback