BringForward(IEnumerable<Element>) Method

In This Topic

Bring the elements forward within their parent's element collection. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void BringForward( 
   IEnumerable<Element> elements
)

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

Parameters

elements: The elements to bring forward

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 CanBringForward(IEnumerable<Element>) to check whether the elements can be brought forward. Element z order can only be changed relative to their parent's element collection. All elements must have the same parent. The top element will have a z order of N - 1 where N is equal to the number of elements within the element parent's element collection. Check individual element z order with Element.ZOrder.

Example

Ordering: Send backward and Bring forward

//On the QueuedTask
//get the current selection set
var sel_elems = layout.GetSelectedElements();
//can they be brought forward? This will also check that all elements have the same parent
if (layout.CanBringForward(sel_elems))
{
  //bring forward
  layout.BringForward(sel_elems);
  //bring to front (of parent)
  //graphicsLayer.BringToFront(sel_elems);
}
else if (layout.CanSendBackward(sel_elems))
{
  //send back
  layout.SendBackward(sel_elems);
  //send to the back (of parent)
  //graphicsLayer.SendToBack(sel_elems);
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Layout Class
Layout Members
Overload List

Send feedback