com.esri.arcgis.carto
Interface IMapSurround

All Superinterfaces:

Serializable

All Known Subinterfaces:

ILegend, IMapInset, INorthArrow, IOverview, IOverview2, IScaleBar, IScaleText, IScaleText2

All Known Implementing Classes:

AlternatingScaleBar, DoubleAlternatingScaleBar, HollowScaleBar, Legend, MapInset, MapTitle, MarkerNorthArrow, Overview, Scalebar, ScaleLine, ScaleText, SingleDivisionScaleBar, SteppedScaleLine

public interface IMapSurround
extends Serializable

Provides access to members that control the map surround.

Remarks

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

Product Availability

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

Method Summary

void	delayEvents(boolean delay) Used to batch operations together to minimize notifications.
void	draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds) Draws the map surround into the specified display bounds.
void	fitToBounds(IDisplay display, IEnvelope bounds, boolean[] changed) Adjusts the map surround to fit the bounds.
int	getIcon() Icon used to represent the map surround.
IMap	getMap() The parent map.
String	getName() Name of the map surround.
void	queryBounds(IDisplay display, IEnvelope oldBounds, IEnvelope newBounds) Returns the bounds of the map surround.
void	refresh() Makes sure the latest updates are refected the next time the Map Surround is drawn.
void	setMapByRef(IMap map) The parent map.
void	setName(String name) Name of the map surround.

Method Detail

getMap

IMap getMap()
            throws IOException,
                   AutomationException

The parent map.

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.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapByRef

void setMapByRef(IMap map)
                 throws IOException,
                        AutomationException

The parent map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Name of the map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Name of the map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIcon

int getIcon()
            throws IOException,
                   AutomationException

Icon used to represent the map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The hIcon (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBounds

void queryBounds(IDisplay display,
                 IEnvelope oldBounds,
                 IEnvelope newBounds)
                 throws IOException,
                        AutomationException

Returns the bounds of the map surround.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

oldBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

newBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fitToBounds

void fitToBounds(IDisplay display,
                 IEnvelope bounds,
                 boolean[] changed)
                 throws IOException,
                        AutomationException

Adjusts the map surround to fit the bounds. The changed argument indicates whether the size of the map surround was changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

changed - The changed (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delayEvents

void delayEvents(boolean delay)
                 throws IOException,
                        AutomationException

Used to batch operations together to minimize notifications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

delay - The delay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh()
             throws IOException,
                    AutomationException

Makes sure the latest updates are refected the next time the Map Surround is drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          ITrackCancel trackCancel,
          IEnvelope bounds)
          throws IOException,
                 AutomationException

Draws the map surround into the specified display bounds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.