SetTOCPositionRelative(IElement,Boolean) Method

In This Topic

Sets the position of an element either above or below a reference element. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SetTOCPositionRelative( 
   IElement targetElement,
   bool isAbove
)

Public Overloads Sub SetTOCPositionRelative( _
   ByVal targetElement As IElement, _
   ByVal isAbove As Boolean _
)

Parameters

targetElement: An existing IElement in the layout TOC.
isAbove: Set to true to place the target above the reference element

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method must be called within the lambda passed to QueuedTask.Run.

Remarks

The reference element can either be at the root level of the layout TOC or an element in a group element. Elements can be easily moved into or out of groups.

Example

Element_SetTOCPositionRelative

//Move a layout element above an existing layout element.

//Perform on the worker thread
await QueuedTask.Run(() =>
{
  element.SetTOCPositionRelative(element, true);
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Element Class
Element Members
Overload List

Send feedback