com.esri.arcgis.carto
Interface IMapSurroundFrame

All Superinterfaces:
IFrameElement, Serializable
All Known Implementing Classes:
MapSurroundFrame

public interface IMapSurroundFrame
extends IFrameElement, Serializable

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

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.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IMapFrame getMapFrame()
          The frame element of the map associated with this object's map surround.
 IMapSurround getMapSurround()
          The map surround displayed by this frame element.
 void setMapFrameByRef(IMapFrame mapFrame)
          The frame element of the map associated with this object's map surround.
 void setMapSurroundByRef(IMapSurround mapSurround)
          The map surround displayed by this frame element.
 
Methods inherited from interface com.esri.arcgis.carto.IFrameElement
getBackground, getBorder, getObject, getThumbnail, isDraftMode, setBackground, setBorder, setDraftMode
 

Method Detail

getMapSurround

IMapSurround getMapSurround()
                            throws IOException,
                                   AutomationException
The map surround displayed by this frame element.

Remarks

The MapSurround property allows you to retrieve or set the surround object (north arrow, legend, or scale bar) stored within the frame.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.IMapSurround
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapSurroundByRef

void setMapSurroundByRef(IMapSurround mapSurround)
                         throws IOException,
                                AutomationException
The map surround displayed by this frame element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
mapSurround - A reference to a com.esri.arcgis.carto.IMapSurround (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapFrame

IMapFrame getMapFrame()
                      throws IOException,
                             AutomationException
The frame element of the map associated with this object's map surround.

Remarks

The MapFrame property returns or sets (by reference) the MapFrame associated with the MapSurround object. For instance, when a scale bar is added it is linked to a particular MapFrame. When the scale of the map within the MapFrame is updated, the scale bar in the linked MapSurroundFrame should also update.

Use this property when you want to retrieve of set the MapFrame linked to the MapSurroundFrame object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.IMapFrame
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapFrameByRef

void setMapFrameByRef(IMapFrame mapFrame)
                      throws IOException,
                             AutomationException
The frame element of the map associated with this object's map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
mapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.