CreateGraphicElement(IElementContainer,CIMGraphic,String,Boolean,ElementInfo) Method

In This Topic

Create a GraphicElement based on the input ArcGIS.Core.CIM.CIMGraphic and element properties. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Function CreateGraphicElement( _
   ByVal elementContainer As IElementContainer, _
   ByVal cimGraphic As CIMGraphic, _
   Optional ByVal elementName As String, _
   Optional ByVal select As Boolean, _
   Optional ByVal elementInfo As ElementInfo _
) As GraphicElement

public GraphicElement CreateGraphicElement( 
   IElementContainer elementContainer,
   CIMGraphic cimGraphic,
   string elementName,
   bool select,
   ElementInfo elementInfo
)

Parameters

elementContainer: The parent element container
cimGraphic: The input graphic
elementName: Element name (optional)
select: Select after create flag (default is true) (optional)
elementInfo: Additional element properties (optional)

Return Value

GraphicElement

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: graphic

Remarks

Refer to GraphicFactory for creating ArcGIS.Core.CIM.CIMGraphic.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 Ellipse Graphic Element

{
  //Note: Must be on QueuedTask.Run

  //Build geometry
  Coordinate2D center = new Coordinate2D(2, 2.75);
  var eabElp = new EllipticArcBuilderEx(center, 0, 1, 0.45,
                                      ArcOrientation.ArcClockwise);
  var ellipse = eabElp.ToSegment();

  //Set symbology, create and add element to layout
  CIMStroke outline = SymbolFactory.Instance.ConstructStroke(
                                  ColorFactory.Instance.GreenRGB, 2.0,
                          SimpleLineStyle.Dot);
  CIMPolygonSymbol ellipseSym = SymbolFactory.Instance.ConstructPolygonSymbol(
                            ColorFactory.Instance.GreyRGB, SimpleFillStyle.Vertical,
                                                    outline);

  var poly = PolygonBuilderEx.CreatePolygon(
    PolylineBuilderEx.CreatePolyline(ellipse, AttributeFlags.AllAttributes));

  var elpElm = ElementFactory.Instance.CreateGraphicElement(
    layout, poly, ellipseSym, "New Ellipse");
}

Create Lasso Line, Freehand Graphic Element

{
  //Note: Must be on QueuedTask.Run
  //Build geometry
  List<Coordinate2D> plCoords = new List<Coordinate2D>();
  plCoords.Add(new Coordinate2D(1.5, 10.5));
  plCoords.Add(new Coordinate2D(1.25, 9.5));
  plCoords.Add(new Coordinate2D(1, 10.5));
  plCoords.Add(new Coordinate2D(0.75, 9.5));
  plCoords.Add(new Coordinate2D(0.5, 10.5));
  plCoords.Add(new Coordinate2D(0.5, 1));
  plCoords.Add(new Coordinate2D(0.75, 2));
  plCoords.Add(new Coordinate2D(1, 1));
  Polyline linePl = PolylineBuilderEx.CreatePolyline(plCoords);

  //Set symbology, create and add element to layout
  CIMLineSymbol lineSym = SymbolFactory.Instance.ConstructLineSymbol(
            ColorFactory.Instance.BlackRGB, 2.0, SimpleLineStyle.Solid);
  //var graphic = GraphicFactory.Instance.CreateShapeGraphic(linePl, lineSym);

  var ge = ElementFactory.Instance.CreateGraphicElement(
                          layout, linePl, lineSym, "New Freehand");
}

Create Lasso Polygon, Freehand Element

{
  //Note: Must be on QueuedTask.Run

  List<Coordinate2D> plyCoords = new List<Coordinate2D>();
  plyCoords.Add(new Coordinate2D(1, 1));
  plyCoords.Add(new Coordinate2D(1.25, 2));
  plyCoords.Add(new Coordinate2D(1.5, 1.1));
  plyCoords.Add(new Coordinate2D(1.75, 2));
  plyCoords.Add(new Coordinate2D(2, 1.1));
  plyCoords.Add(new Coordinate2D(2.25, 2));
  plyCoords.Add(new Coordinate2D(2.5, 1.1));
  plyCoords.Add(new Coordinate2D(2.75, 2));
  plyCoords.Add(new Coordinate2D(3, 1));
  Polygon poly = PolygonBuilderEx.CreatePolygon(plyCoords);

  //Set symbology, create and add element to layout
  CIMStroke outline = SymbolFactory.Instance.ConstructStroke(
              ColorFactory.Instance.BlackRGB, 2.0, SimpleLineStyle.Solid);
  CIMPolygonSymbol polySym = SymbolFactory.Instance.ConstructPolygonSymbol(
           ColorFactory.Instance.RedRGB, SimpleFillStyle.ForwardDiagonal, outline);

  ElementFactory.Instance.CreateGraphicElement(
    layout, poly, polySym, "New Lasso");
}

Create Line Element

{
  //Note: Must be on QueuedTask.Run

  //Build geometry
  List<Coordinate2D> plCoords = new List<Coordinate2D>();
  plCoords.Add(new Coordinate2D(1, 8.5));
  plCoords.Add(new Coordinate2D(1.66, 9));
  plCoords.Add(new Coordinate2D(2.33, 8.1));
  plCoords.Add(new Coordinate2D(3, 8.5));
  Polyline linePl = PolylineBuilderEx.CreatePolyline(plCoords);

  //Reference a line symbol in a style
  var ProjectStyles = Project.Current.GetItems<StyleProjectItem>();
  StyleProjectItem style = ProjectStyles.First(x => x.Name == "ArcGIS 2D");
  var symStyle = style.SearchSymbols(StyleItemType.LineSymbol, "Line with 2 Markers")[0];
  CIMLineSymbol lineSym = symStyle.Symbol as CIMLineSymbol;
  lineSym.SetSize(20);

  //Set symbology, create and add element to layout
  //CIMLineSymbol lineSym = SymbolFactory.Instance.ConstructLineSymbol(ColorFactory.Instance.BlueRGB, 4.0, SimpleLineStyle.Solid);
  ElementFactory.Instance.CreateGraphicElement(
    layout, linePl, lineSym, "New Line");
}

Create Point Element

{
  //Note: Must be on QueuedTask.Run(() => { ...

  //Build geometry
  Coordinate2D coord2D = new Coordinate2D(2.0, 10.0);

  //Reference a point symbol in a style
  StyleProjectItem stylePrjItm = Project.Current.GetItems<StyleProjectItem>()
            .FirstOrDefault(item => item.Name == "ArcGIS 2D");
  SymbolStyleItem symStyleItm = stylePrjItm.SearchSymbols(
                        StyleItemType.PointSymbol, "City Hall")[0];
  CIMPointSymbol pointSym = symStyleItm.Symbol as CIMPointSymbol;
  pointSym.SetSize(50);

  var elemInfo = new ElementInfo()
  {
    CustomProperties = new List<CIMStringMap>() {
    new CIMStringMap() { Key = "Key1", Value = "Value1"},
    new CIMStringMap() { Key = "Key2", Value = "Value2"}
  },
    Anchor = Anchor.TopRightCorner,
    Rotation = 45.0
  };

  var graphic = GraphicFactory.Instance.CreateSimpleGraphic(
                                coord2D.ToMapPoint(), pointSym);

  ElementFactory.Instance.CreateGraphicElement(
    layout, graphic, "New Point", true, elemInfo);
}

Create Polygon Element

{
  //Note: Must be on QueuedTask.Run

  //Build geometry
  List<Coordinate2D> plyCoords = new List<Coordinate2D>();
  plyCoords.Add(new Coordinate2D(1, 7));
  plyCoords.Add(new Coordinate2D(2, 7));
  plyCoords.Add(new Coordinate2D(2, 6.7));
  plyCoords.Add(new Coordinate2D(3, 6.7));
  plyCoords.Add(new Coordinate2D(3, 6.1));
  plyCoords.Add(new Coordinate2D(1, 6.1));
  Polygon poly = PolygonBuilderEx.CreatePolygon(plyCoords);

  //Set symbology, create and add element to layout
  CIMStroke outline = SymbolFactory.Instance.ConstructStroke(
    ColorFactory.Instance.BlueRGB, 2.0, SimpleLineStyle.DashDotDot);
  CIMPolygonSymbol polySym = SymbolFactory.Instance.ConstructPolygonSymbol(
    ColorFactory.Instance.RedRGB, SimpleFillStyle.ForwardDiagonal, outline);

  ElementFactory.Instance.CreateGraphicElement(
    layout, poly, polySym, "New Polygon", false);
}

Create Rectangle Element

{
  //Note: Must be on QueuedTask.Run

  //Build geometry
  Coordinate2D ll = new Coordinate2D(1.0, 4.75);
  Coordinate2D ur = new Coordinate2D(3.0, 5.75);
  Envelope env = EnvelopeBuilderEx.CreateEnvelope(ll, ur);

  //Set symbology, create and add element to layout
  CIMStroke outline = SymbolFactory.Instance.ConstructStroke(
    ColorFactory.Instance.BlackRGB, 5.0, SimpleLineStyle.Solid);
  CIMPolygonSymbol polySym = SymbolFactory.Instance.ConstructPolygonSymbol(
    ColorFactory.Instance.GreenRGB, SimpleFillStyle.DiagonalCross, outline);

  var ge = GraphicFactory.Instance.CreateSimpleGraphic(env, polySym);
  var elemInfo = new ElementInfo()
  {
    Anchor = Anchor.CenterPoint,
    Rotation = 45.0,
    CornerRounding = 5.0
  };

  ElementFactory.Instance.CreateGraphicElement(
    layout, env, polySym, "New Rectangle", false, elemInfo);
}

Create Bezier Curve Element

{
  //Note: Must be on QueuedTask.Run
  //Build geometry
  Coordinate2D pt1 = new Coordinate2D(1, 7.5);
  Coordinate2D pt2 = new Coordinate2D(1.66, 8);
  Coordinate2D pt3 = new Coordinate2D(2.33, 7.1);
  Coordinate2D pt4 = new Coordinate2D(3, 7.5);
  var bez = new CubicBezierBuilderEx(pt1, pt2, pt3, pt4);
  var bezSeg = bez.ToSegment();
  Polyline bezPl = PolylineBuilderEx.CreatePolyline(bezSeg, AttributeFlags.AllAttributes);

  //Set symbology, create and add element to layout
  CIMLineSymbol lineSym = SymbolFactory.Instance.ConstructLineSymbol(
    ColorFactory.Instance.RedRGB, 4.0, SimpleLineStyle.DashDot);

  ElementFactory.Instance.CreateGraphicElement(layout, bezPl, lineSym, "New Bezier");
}

Create Graphic Element using CIMGraphic

{
  //Note: on the QueuedTask
  //Place symbol on the layout
  MapPoint location = MapPointBuilderEx.CreateMapPoint(new Coordinate2D(9, 1));

  //specify a symbol
  var pt_symbol = SymbolFactory.Instance.ConstructPointSymbol(
                        ColorFactory.Instance.GreenRGB);

  //create a CIMGraphic 
  var graphic = new CIMPointGraphic()
  {
    Symbol = pt_symbol.MakeSymbolReference(),
    Location = location //center of map
  };
  //Or use GraphicFactory
  var graphicFactory = GraphicFactory.Instance.CreateSimpleGraphic(location, pt_symbol);

  ElementFactory.Instance.CreateGraphicElement(layout, graphic);
  ElementFactory.Instance.CreateGraphicElement(layout, graphicFactory);
}

Create Graphic Element using CIMSymbol

{
  //Note: Must be on QueuedTask.Run
  //Place symbol on the layout
  MapPoint location = MapPointBuilderEx.CreateMapPoint(new Coordinate2D(9, 1));

  //specify a symbol
  var pt_symbol = SymbolFactory.Instance.ConstructPointSymbol(
                        ColorFactory.Instance.GreenRGB);

  ElementFactory.Instance.CreateGraphicElement(layout, location, pt_symbol);
}

Create point graphic with symbology

{
  //Create a simple 2D point graphic and apply an existing point style item as the symbology.
  //Note: Must be on QueuedTask.Run
  //Build 2D point geometry  
  Coordinate2D coord2D = new Coordinate2D(2.0, 10.0);

  //(optionally) Reference a point symbol in a style
  StyleProjectItem ptStylePrjItm = Project.Current.GetItems<StyleProjectItem>()
                                .FirstOrDefault(item => item.Name == "ArcGIS 2D");
  SymbolStyleItem ptSymStyleItm = ptStylePrjItm.SearchSymbols(
                                         StyleItemType.PointSymbol, "City Hall")[0];
  CIMPointSymbol pointSym = ptSymStyleItm.Symbol as CIMPointSymbol;
  pointSym.SetSize(50);

  //Set symbology, create and add element to layout

  //An alternative simple symbol is also commented out below.
  //This would eliminate the four optional lines of code above that
  //reference a style.
  //CIMPointSymbol pointSym = SymbolFactory.Instance.ConstructPointSymbol(
  //                  ColorFactory.Instance.RedRGB, 25.0, SimpleMarkerStyle.Star);  

  GraphicElement ptElm = ElementFactory.Instance.CreateGraphicElement(
                                 layout, coord2D.ToMapPoint(), pointSym);
  ptElm.SetName("New Point");
}

Create line graphic with symbology

{
  //Create a simple 2D line graphic and apply an existing line
  //style item as the symbology.
  //Note: Must be on QueuedTask.Run
  //Build 2d line geometry
  List<Coordinate2D> plCoords = new List<Coordinate2D>();
  plCoords.Add(new Coordinate2D(1, 8.5));
  plCoords.Add(new Coordinate2D(1.66, 9));
  plCoords.Add(new Coordinate2D(2.33, 8.1));
  plCoords.Add(new Coordinate2D(3, 8.5));

  Polyline linePl = PolylineBuilderEx.CreatePolyline(plCoords);

  //(optionally) Reference a line symbol in a style
  StyleProjectItem lnStylePrjItm = Project.Current.GetItems<StyleProjectItem>()
                                .FirstOrDefault(item => item.Name == "ArcGIS 2D");
  SymbolStyleItem lnSymStyleItm = lnStylePrjItm.SearchSymbols(
                                StyleItemType.LineSymbol, "Line with 2 Markers")[0];
  CIMLineSymbol lineSym = lnSymStyleItm.Symbol as CIMLineSymbol;
  lineSym.SetSize(20);

  //Set symbology, create and add element to layout

  //An alternative simple symbol is also commented out below.
  //This would eliminate the four optional lines of code above that
  //reference a style.
  //
  //CIMLineSymbol lineSym = SymbolFactory.Instance.ConstructLineSymbol(
  //         ColorFactory.Instance.BlueRGB, 4.0, SimpleLineStyle.Solid);  


  GraphicElement lineElm = ElementFactory.Instance.CreateGraphicElement(
                                              layout, linePl, lineSym);
  lineElm.SetName("New Line");
}

Create rectangle graphic with simple symbology

{
  //Create a simple 2D rectangle graphic and apply simple fill and
  //outline symbols.

  //Note: Must be on QueuedTask.Run

  //Build 2D envelope geometry
  Coordinate2D rec_ll = new Coordinate2D(1.0, 4.75);
  Coordinate2D rec_ur = new Coordinate2D(3.0, 5.75);

  Envelope rec_env = EnvelopeBuilderEx.CreateEnvelope(rec_ll, rec_ur);

  //Set symbology, create and add element to layout
  CIMStroke outline = SymbolFactory.Instance.ConstructStroke(
    ColorFactory.Instance.BlackRGB, 5.0, SimpleLineStyle.Solid);
  CIMPolygonSymbol polySym = SymbolFactory.Instance.ConstructPolygonSymbol(
    ColorFactory.Instance.GreenRGB, SimpleFillStyle.DiagonalCross, outline);


  GraphicElement recElm = ElementFactory.Instance.CreateGraphicElement(
    layout, rec_env, polySym, "New Rectangle");
  //Or use Predefined shape
  GraphicElement recElm2 = ElementFactory.Instance.CreatePredefinedShapeGraphicElement(
                            layout, PredefinedShape.Rectangle, rec_env, polySym,
                            "New Rectangle2");
}

Create Picture Graphic Element using CIMSymbol

{
  //Note: Must be on QueuedTask.Run(() => { ...

  //Build geometry
  Coordinate2D ll = new Coordinate2D(0.5, 1);
  Coordinate2D ur = new Coordinate2D(2.5, 2);
  Envelope env = EnvelopeBuilderEx.CreateEnvelope(ll, ur);

  //Create and add element to layout
  string picPath = System.IO.Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.MyPictures),
    "SamplePicture.jpg");
  var pic_gr = ElementFactory.Instance.CreatePictureGraphicElement(
    layout, env.Center, picPath, "New Picture", true, new ElementInfo() { Anchor = Anchor.CenterPoint });
}

Translates a point in map coordinates to a point in page coordinates

{
  //Note: Must be on QueuedTask.Run
  var pointSymbol = SymbolFactory.Instance.ConstructPointSymbol(ColorFactory.Instance.BlackRGB, 8);
  //Convert the clicked point in client coordinates to the corresponding map coordinates.
  //clicked point can be from a Map Tool's HandleMouseDownAsync callback.
  //MapViewMouseButtonEventArgs ClientPoint property.
  Point clickedPoint;
  var clickedMapPoint = MapView.Active.ClientToMap(clickedPoint);
  ArcGIS.Desktop.Framework.Dialogs.MessageBox.Show(string.Format("X: {0} Y: {1} Z: {2}",
      mapPoint.X, mapPoint.Y, mapPoint.Z), "Map Coordinates");
  //Get the corresponding layout point
  var pointOnLayoutFrame = mapFrame.MapToPage(mapPoint);

  //Create a point graphic on the Layout.
  var cimGraphicElement = new CIMPointGraphic
  {
    Location = pointOnLayoutFrame,
    Symbol = pointSymbol.MakeSymbolReference()
  };
  //Or use GraphicFactory
  var cimGraphicElement2 = GraphicFactory.Instance.CreateSimpleGraphic(
          pointOnLayoutFrame, pointSymbol);

  ElementFactory.Instance.CreateGraphicElement(layout, cimGraphicElement);
  ElementFactory.Instance.CreateGraphicElement(layout, cimGraphicElement2);
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

ElementFactory Class
ElementFactory Members
Overload List

Send feedback