com.esri.arcgis.carto
Interface IMapAutoExtentOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

Map

public interface IMapAutoExtentOptions
extends Serializable

Provides access to the Map's auto extent options.

Product Availability

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

Method Summary

IEnvelope	getAutoExtentBounds() The bounds of the map displayed by the frame.
IFeatureLayer	getAutoExtentLayer() Auto extent features.
IMap	getAutoExtentMap() Auto extent map.
double	getAutoExtentMargin() Auto extent margin.
int	getAutoExtentMarginUnits() Auto extent margin units.
double	getAutoExtentScale() The scale at which the map should be displayed.
int	getAutoExtentType() The way in which the map extent of the frame is specified.
void	getLockedPan(boolean[] flag) Check if the map can be panned.
void	getLockedZoom(boolean[] flag) Check if the map can be zoomed.
void	setAutoExtentBounds(IEnvelope bounds) The bounds of the map displayed by the frame.
void	setAutoExtentLayerByRef(IFeatureLayer layer) Auto extent features.
void	setAutoExtentMapByRef(IMap map) Auto extent map.
void	setAutoExtentMargin(double margin) Auto extent margin.
void	setAutoExtentMarginUnits(int units) Auto extent margin units.
void	setAutoExtentScale(double scale) The scale at which the map should be displayed.
void	setAutoExtentType(int type) The way in which the map extent of the frame is specified.

Method Detail

getAutoExtentType

int getAutoExtentType()
                      throws IOException,
                             AutomationException

The way in which the map extent of the frame is specified.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriExtentTypeEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoExtentType

void setAutoExtentType(int type)
                       throws IOException,
                              AutomationException

The way in which the map extent of the frame is specified.

Product Availability

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

Parameters:

type - A com.esri.arcgis.carto.esriExtentTypeEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAutoExtentScale

double getAutoExtentScale()
                          throws IOException,
                                 AutomationException

The scale at which the map should be displayed.

Product Availability

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

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoExtentScale

void setAutoExtentScale(double scale)
                        throws IOException,
                               AutomationException

The scale at which the map should be displayed.

Product Availability

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

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAutoExtentBounds

IEnvelope getAutoExtentBounds()
                              throws IOException,
                                     AutomationException

The bounds of the map displayed by the frame.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoExtentBounds

void setAutoExtentBounds(IEnvelope bounds)
                         throws IOException,
                                AutomationException

The bounds of the map displayed by the frame.

Product Availability

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

Parameters:

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.

getAutoExtentMap

IMap getAutoExtentMap()
                      throws IOException,
                             AutomationException

Auto extent map. Derive extent from the extent of another map. See esriExtentTypeEnum.

Product Availability

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

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.

setAutoExtentMapByRef

void setAutoExtentMapByRef(IMap map)
                           throws IOException,
                                  AutomationException

Auto extent map. Derive extent from the extent of another map. See esriExtentTypeEnum.

Product Availability

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

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.

getAutoExtentMargin

double getAutoExtentMargin()
                           throws IOException,
                                  AutomationException

Auto extent margin. Specified in AutoExtentMarginUnits. See esriExtentTypeEnum.

Product Availability

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

Returns:

The margin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoExtentMargin

void setAutoExtentMargin(double margin)
                         throws IOException,
                                AutomationException

Auto extent margin. Specified in AutoExtentMarginUnits. See esriExtentTypeEnum.

Product Availability

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

Parameters:

margin - The margin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAutoExtentMarginUnits

int getAutoExtentMarginUnits()
                             throws IOException,
                                    AutomationException

Auto extent margin units. See esriExtentTypeEnum.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoExtentMarginUnits

void setAutoExtentMarginUnits(int units)
                              throws IOException,
                                     AutomationException

Auto extent margin units. See esriExtentTypeEnum.

Product Availability

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

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAutoExtentLayer

IFeatureLayer getAutoExtentLayer()
                                 throws IOException,
                                        AutomationException

Auto extent features. See esriExtentTypeEnum.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IFeatureLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoExtentLayerByRef

void setAutoExtentLayerByRef(IFeatureLayer layer)
                             throws IOException,
                                    AutomationException

Auto extent features. See esriExtentTypeEnum.

Product Availability

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

Parameters:

layer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockedZoom

void getLockedZoom(boolean[] flag)
                   throws IOException,
                          AutomationException

Check if the map can be zoomed.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLockedPan

void getLockedPan(boolean[] flag)
                  throws IOException,
                         AutomationException

Check if the map can be panned.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.