This document is archived and information here might be outdated.  Recommended version.


MapSurroundFrame CoClass (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Carto)  

MapSurroundFrame CoClass

A graphic element for displaying map surrounds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Interfaces

Interfaces Description
IBoundsProperties Provides access to members that control Bounds Properties.
IClone (esriSystem) Provides access to members that control cloning of objects.
IElement Provides access to members that control the Element.
IElementProperties Provides access to members that control the Element Properties.
IElementProperties2 Provides access to members that control More Element Properties.
IElementProperties3 Provides access to members that control More Element Properties.
IFrameDraw Provides access to members that control frame drawing.
IFrameElement Provides access to members that control the Frame element object.
IFrameProperties Provides access to members that control the General properties for a frame.
IGraphicsComposite Provides access to members that control objects that are composed of graphic elements.
IMapFrameEvents Provides access to the events that occur when the state of the map frame changes.
IMapSurroundEvents Provides access to events that occur when the state of the map surrounds changes.
IMapSurroundFrame Provides access to the members that control the map surround element interface.
IPersistStream (esriSystem)
IPropertySupport (esriSystem) Provides access to members that set a default property on an object.
ITransform2D (esriGeometry) Provides access to methods for transforming geometries using either specific parameters or arbitrary transformation objects (affine transformations, geographic transformations, etc.).
ITransformEvents (esriDisplay) Provides access to members that control Transform Events.

Remarks

The MapSurroundFrame object is descended from a FrameElement.  The object contains map surround objects such as north arrows, legends, and scale bars.  The primary interface for MapSurroundFrame is IMapSurroundFrame .
Use this object when you want to manipulate the frames of surround objects such as north arrows, legends and scale bars or get a reference to these objects from their frame.

Geometry: MapSurroundFrame accepts geometry of type esriGeometryEnvelope or esriGeometryPolygon.  If an envelope is passed it, it is converted to a Polygon internally.  The geometry represents the geometry of the frame that is drawn and it is typically a rectangle.