CreateGroupElement(ILayoutElementContainer,Element) Method

Creates a group element with a single element. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public GroupElement CreateGroupElement( 
   ILayoutElementContainer elementContainer,
   Element element
)

Public Overloads Function CreateGroupElement( _
   ByVal elementContainer As ILayoutElementContainer, _
   ByVal element As Element _
) As GroupElement

Parameters

elementContainer: Layout or GroupElement
element: Element.

Return Value

Returns a GroupElement.

Exceptions

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

Remarks

If the element container is a Layout then the element gets added to the root level of the layout TOC at the top most position. If the element container is a GroupElement then it gets added to the group at the topmost position.

Example

//Create a group with a single element at the root level of the contents pane.

//Find an existing element
Element titleElm = layout.FindElement("Title") as Element;

//Construct on the worker thread
await QueuedTask.Run(() =>
{
  GroupElement groupWithSingleElementAtRoot = LayoutElementFactory.Instance.CreateGroupElement(layout, titleElm);
  groupWithSingleElementAtRoot.SetName("Group with single element at root");
});

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

LayoutElementFactory Class
LayoutElementFactory Members
Overload List