CanBringForward(Element) Method

In This Topic

Checks whether the given element can be moved forward within its parent's element collection. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public bool CanBringForward( 
   Element element
)

Public Overloads Function CanBringForward( _
   ByVal element As Element _
) As Boolean

Parameters

element: The element to check

Return Value

True if the element can be moved forward.

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

Remarks

Element z order is relative to the element collection within their parent. The bottom element has a z order of 0. The top element has a z order of N - 1. If the element is already at the top 0 false is returned. False can also be returned if the element's z order cannot be checked (i.e. the element is not a graphic element, a group element, does not belong to the graphics layer, etc.).

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