CreateGroupElement Method (PresentationElementFactory)

In This Topic

Creates a group element from the input element collection and element properties.

Syntax

C#
Visual Basic (Declaration)

public GroupElement CreateGroupElement( 
   IElementContainer elementContainer,
   IEnumerable<Element> elements,
   string elementName,
   bool select,
   ElementInfo groupElementInfo
)

Public Function CreateGroupElement( _
   ByVal elementContainer As IElementContainer, _
   Optional ByVal elements As IEnumerable(Of Element), _
   Optional ByVal elementName As String, _
   Optional ByVal select As Boolean, _
   Optional ByVal groupElementInfo As ElementInfo _
) As GroupElement

Parameters

elementContainer: The parent element container. It can be a presentation page or a group element that is associated with a presentation page.
elements: The collection of elements to be grouped (optional)
elementName: An element name (optional)
select: Select after create flag (default is true) (optional)
groupElementInfo: Additional element properties (optional)

Return Value

ArcGIS.Desktop.Layouts.GroupElement

Remarks

Only elements contained within the provided elementContainer will be added to the group element. If elements is null or an empty collection then an empty GroupElement will be created.

Example

Create elements on a presentation page

//Must be on QueuedTask
await QueuedTask.Run(() =>
{
  //create a picture element
  var imgPath = @"https://www.esri.com/content/dam/esrisites/en-us/home/" +
   "homepage-tile-podcast-business-resilience-climate-change.jpg";

  //Build a geometry to place the picture
  Coordinate2D ll = new Coordinate2D(3.5, 1);
  Coordinate2D ur = new Coordinate2D(6, 5);
  Envelope env = EnvelopeBuilderEx.CreateEnvelope(ll, ur);
  //create a picture element on the page
  var gElement = PresentationElementFactory.Instance.CreatePictureGraphicElement(page, env, imgPath);

  //create a text element
  //Set symbology, create and add element to a presentation page
  CIMTextSymbol sym = SymbolFactory.Instance.ConstructTextSymbol(
                ColorFactory.Instance.RedRGB, 15, "Arial", "Regular");
  //use ElementInfo to set placement properties
  var elemInfo = new ElementInfo()
  {
    Anchor = Anchor.CenterPoint,
    Rotation = 45
  };
  string textString = "My text";
  var textPos = new Coordinate2D(5, 3).ToMapPoint();
  var tElement = PresentationElementFactory.Instance.CreateTextGraphicElement(page,
    TextType.PointText, textPos, sym, textString, "telement", false, elemInfo);

  //create a group element with elements created above
  var elmList = new List<Element> { gElement, tElement };
  GroupElement grp1 = PresentationElementFactory.Instance.CreateGroupElement(page, elmList, "My Group");
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.5 or higher.

Reference

PresentationElementFactory Class
PresentationElementFactory Members

Send feedback