CreateMapSurroundElement Method (IElementFactory)

In This Topic

Create a map surround element based on the geometry and associated map surround and element properties. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Function CreateMapSurroundElement( _
   ByVal elementContainer As IElementContainer, _
   ByVal frameOrLocation As Geometry, _
   ByVal surroundInfo As MapSurroundInfo, _
   Optional ByVal elementName As String, _
   Optional ByVal select As Boolean, _
   Optional ByVal elementInfo As ElementInfo _
) As MapSurround

MapSurround CreateMapSurroundElement( 
   IElementContainer elementContainer,
   Geometry frameOrLocation,
   MapSurroundInfo surroundInfo,
   string elementName,
   bool select,
   ElementInfo elementInfo
)

Parameters

elementContainer: The parent element container
frameOrLocation: The map surround frame envelope or center point
surroundInfo: Associated surround properties
elementName: An element name (optional)
select: Select after create flag (default is true) (optional)
elementInfo: Additional element properties (optional)

Return Value

MapSurround

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.ArgumentNullException	Value cannot be null: surroundInfo
System.ArgumentException	frameOrLocation must be a point or envelope
System.ArgumentException	elementContainer must be a layout or group element (on a layout)

Remarks

Graphic layers are not valid containers for surrounds. The frameOrLocation can be either a ArcGIS.Core.Geometry.MapPoint or ArcGIS.Core.Geometry.Envelope. A default extent will be calculated if a map point is provided (rather than an envelope).

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

IElementFactory Interface
IElementFactory Members

Send feedback