CreateMapFrameElement Method (ElementFactory)

In This Topic

Create a map frame element based on the input map frame polygon and map URI. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Function CreateMapFrameElement( _
   ByVal elementContainer As IElementContainer, _
   ByVal frameOrLocation As Geometry, _
   ByVal map As Map, _
   Optional ByVal elementName As String, _
   Optional ByVal select As Boolean, _
   Optional ByVal elementInfo As ElementInfo _
) As MapFrame

public MapFrame CreateMapFrameElement( 
   IElementContainer elementContainer,
   Geometry frameOrLocation,
   Map map,
   string elementName,
   bool select,
   ElementInfo elementInfo
)

Parameters

elementContainer: The parent element container
frameOrLocation: The map frame location (point), envelope, or polygon
map: The map (to be) associated with the frame (can be null)
elementName: An element name (optional)
select: Select after create flag (default is true) (optional)
elementInfo: Additional element properties (optional)

Return Value

MapFrame

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	Empty or null geometry
System.ArgumentException	frameOrLocation - invalid geometry type
System.ArgumentException	elementContainer must be a layout or group element (on a layout)

Remarks

Graphic layers are not valid containers for map frames. 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.
If a point is provided as the frame geometry then a default extent will be applied.

Example

Create Map Frame and Set Camera

{
  //Create a map frame and set its camera by zooming to the extent of an existing bookmark.
  //Construct on the worker thread

  //Build 2D envelope geometry
  Coordinate2D mf_ll = new Coordinate2D(6.0, 8.5);
  Coordinate2D mf_ur = new Coordinate2D(8.0, 10.5);
  Envelope mf_env = EnvelopeBuilderEx.CreateEnvelope(mf_ll, mf_ur);

  //Reference map, create MF and add to layout
  MapProjectItem mapPrjItem = Project.Current.GetItems<MapProjectItem>()
                       .FirstOrDefault(item => item.Name.Equals("Map"));
  Map mfMap = mapPrjItem.GetMap();
  Bookmark bookmark = mfMap.GetBookmarks().FirstOrDefault(
                        b => b.Name == "Great Lakes");

  MapFrame mfElm = ElementFactory.Instance.CreateMapFrameElement(
                       layout, mf_env, mfMap, "New Map Frame");

  //Zoom to bookmark
  mfElm.SetCamera(bookmark);
}

Create Map Frame 1

{
  //Note: QueuedTask.Run

  //Build geometry
  Coordinate2D ll = new Coordinate2D(2.0, 4.5);
  Coordinate2D ur = new Coordinate2D(4.0, 6.5);
  Envelope env = EnvelopeBuilderEx.CreateEnvelope(ll, ur);

  //Reference map, create MF and add to layout
  MapFrame mfElm = ElementFactory.Instance.CreateMapFrameElement(layout, env, map);
}

Create Map Frame 2

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

  //Build geometry
  Coordinate2D ll = new Coordinate2D(4.0, 2.5);
  Coordinate2D ur = new Coordinate2D(7.0, 5.5);
  Envelope env = EnvelopeBuilderEx.CreateEnvelope(ll, ur);

  MapFrame mfElm = ElementFactory.Instance.CreateMapFrameElement(
  layout, env.Center, map);
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

ElementFactory Class
ElementFactory Members

Send feedback