IMapSurroundFrame Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IM > IMapSurroundFrame Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Carto)  

IMapSurroundFrame Interface

Provides access to the members that control the map surround element interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

When To Use

IMapSurroundFrame is the default interface for the MapSurroundFrame object.  Use this interface to obtain or update the surround object (north arrow, scale bar, or legend) stored within the frame, or when you want to obtain or update the MapFrame associated with the surround.

 

Members

Name Description
Read/write property Background Frame background used by this element.
Read/write property Border Frame border used by this element.
Read/write property DraftMode Indicates if this element is in draft mode, i.e., draws fast.
Read/write property MapFrame The frame element of the map associated with this object's map surround.
Read/write property MapSurround The map surround displayed by this frame element.
Read-only property Object Object framed by this element.
Read-only property Thumbnail Small bitmap representation of this element.

Inherited Interfaces

Interfaces Description
IFrameElement Provides access to members that control the Frame element object.

CoClasses that implement IMapSurroundFrame

CoClasses and Classes Description
MapSurroundFrame A graphic element for displaying map surrounds.

Remarks

IMapSurroundFrame provides access to the properties and method of a map surround.  When creating a new map surround frame it is recommended that IMapFrame::CreateSurroundFrame is used rather than creating the class and hooking it up to the Map / MapFrame separately.

.NET Snippets

Add North Arrow | Add Scale Bar | Add Legend

.NET Samples

Add map surrounds using the SymbologyControl (Code Files: NorthArrows ScaleBars ScaleText) | Update a legend format with SymbologyControl area and line patches (Code Files: AreaLinePatches)

.NET Related Topics

Working with map surrounds