CreateTextGraphicElement Method (PresentationElementFactory)

In This Topic

Creates a text graphic based on the input geometry, symbol, and text and other optional parameters.

Syntax

C#
Visual Basic (Declaration)

public GraphicElement CreateTextGraphicElement( 
   IElementContainer elementContainer,
   TextType textType,
   Geometry geometry,
   CIMTextSymbol textSymbol,
   string text,
   string elementName,
   bool select,
   ElementInfo elementInfo
)

Public Function CreateTextGraphicElement( _
   ByVal elementContainer As IElementContainer, _
   ByVal textType As TextType, _
   ByVal geometry As Geometry, _
   Optional ByVal textSymbol As CIMTextSymbol, _
   Optional ByVal text As String, _
   Optional ByVal elementName As String, _
   Optional ByVal select As Boolean, _
   Optional ByVal elementInfo As ElementInfo _
) As GraphicElement

Parameters

elementContainer: The parent element container. It can be a presentation page or a group element that is associated with a presentation page.
textType: The type of text graphic to create
geometry: The geometry for the resulting graphic
textSymbol: The text symbol to be used with the graphic (optional)
text: The text string (optional)
elementName: An element name (optional)
select: Select after create flag (default is true) (optional)
elementInfo: Additional element properties (optional)

Return Value

A ArcGIS.Desktop.Layouts.GraphicElement

Remarks

For:

TextType.PointText use a point
TextType.SplinedText use a polyline (straight or curved)
TextType.CircleParagraph use a circle (polygon) or point
TextType.EllipseParagraph use an ellipse (polygon) or point
TextType.RectangleParagraph use an envelope or point
TextType.PolygonParagraph use a polygon or point

If a point is used as the input for the paragraph text types, a default element extent is applied. if you want to use a text graphic previously created, eg via:

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