SetTOCPositionAbsolute Method (Element)

In This Topic

Sets the position of an element either at the top or bottom of the layout TOC or a group element. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SetTOCPositionAbsolute( 
   IElementContainer targetContainer,
   bool isTop
)

Public Sub SetTOCPositionAbsolute( _
   ByVal targetContainer As IElementContainer, _
   ByVal isTop As Boolean _
)

Parameters

targetContainer: Reference to a Layout or a GroupElement
isTop: Boolean

Exceptions

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

Remarks

If set to true, the element is placed at the top of the layout TOC or the top position in a group element. Elements can be easily moved into or out of groups.

Example

Element_ConvertToGraphics

//Convert a legend to a graphic and move the Title to the bottom of the legend and also move
//the label in the contents pane to the bottom of the list.

//Perform on the worker thread
await QueuedTask.Run(() =>
{
  Legend leg = layout.FindElement("Legend") as Legend;
  GroupElement result = leg.ConvertToGraphics().First() as GroupElement;
  Element firstElm = result.Elements.First();  //Note: Bottom element is first in drawing order.
  foreach (Element elm in result.Elements)
  {
    if (elm.Name == "Title")
    {
      elm.SetY(firstElm.GetY() - 0.25);  //Move title below other legend elements
      elm.SetTOCPositionAbsolute(result, false);  // Move Title item in TOC to bottom as well
    }
  }
});

Element_SetTOCPositionAbsolute

//Move an element to the top of the TOC

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

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Element Class
Element Members

Send feedback