CreateMapFrame(ILayoutElementContainer,Envelope,Map) Method

Creates a map frame element on a layout from an envelope geometry. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public MapFrame CreateMapFrame( 
   ILayoutElementContainer elementContainer,
   Envelope envelope,
   Map map
)

Public Overloads Function CreateMapFrame( _
   ByVal elementContainer As ILayoutElementContainer, _
   ByVal envelope As Envelope, _
   Optional ByVal map As Map _
) As MapFrame

Parameters

elementContainer: Layout or GroupElement
envelope: Envelope
map: Map

Return Value

Returns a MapFrame.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.InvalidOperationException	Map has reached maximum graphics count limit of 4000 elements. One or more elements cannot be created.
System.InvalidOperationException	Map has reached maximum graphics size limit of 10 MB. One or more elements cannot be created.

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 map frame and set its camera by zooming to the extent of an existing bookmark.

//Construct on the worker thread
await QueuedTask.Run(() =>
{
  //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 = EnvelopeBuilder.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 = LayoutElementFactory.Instance.CreateMapFrame(layout, mf_env, mfMap);
  mfElm.SetName("New Map Frame");

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

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

LayoutElementFactory Class
LayoutElementFactory Members
Overload List