SendBackward(GraphicsLayer,Element) Method

In This Topic

Syntax
Exceptions
Remarks
Example
Requirements
See Also

Send the element backward within its parent's element collection. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public static void SendBackward( 
   GraphicsLayer graphicsLayer,
   Element element
)

Public Overloads Shared Sub SendBackward( _
   ByVal graphicsLayer As GraphicsLayer, _
   ByVal element As Element _
)

Parameters

graphicsLayer
element: The element to send backward

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentNullException	Value cannot be null: element
System.ArgumentException	elements must belong to graphicsLayer

Remarks

Refer to CanSendBackward(GraphicsLayer,Element) to check whether an element can be sent backward. Element z order can only be changed relative to its parent's element collection. The bottom element will have a z order of 0 within the element parent's element collection. Check z order with ArcGIS.Desktop.Layouts.Element.ZOrder.
The map view displaying the graphics layer should be initialized.

Example

Ordering: Send backward and Bring forward

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

Ordering: Send backward and Bring forward

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

GraphicsLayerExtensions Class
GraphicsLayerExtensions Members
Overload List

Send feedback