com.esri.arcgis.carto
Interface IMapDescription3

All Superinterfaces:

Serializable

public interface IMapDescription3
extends Serializable

Provides access to the available properties of a map description object.

Product Availability

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

Method Summary

IFillSymbol	getBackgroundSymbol() Background symbol of the Map.
IGraphicElements	getCustomGraphics() Custom graphics.
ILayerDescriptions	getLayerDescriptions() A collection of Layer Description objects, each describing a layer within the map (data frame).
IMapArea	getMapArea() The display area of the map (data frame).
double	getMapRotation() The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.
String	getName() The name of the map (data frame).
IColor	getSelectionColor() The default selection color.
ISpatialReference	getSpatialReference() The spatial reference of the map (data frame).
IColor	getTransparentColor() The color that is transparent (100 %).
boolean	isHonorLayerReordering() Indicates if this object's custom layer order is honored.
void	setBackgroundSymbol(IFillSymbol fillSymbol) Background symbol of the Map.
void	setCustomGraphics(IGraphicElements elements) Custom graphics.
void	setHonorLayerReordering(boolean honorLayerReorder) Indicates if this object's custom layer order is honored.
void	setLayerDescriptions(ILayerDescriptions layerDescriptions) A collection of Layer Description objects, each describing a layer within the map (data frame).
void	setMapArea(IMapArea area) The display area of the map (data frame).
void	setMapRotation(double angleDegrees) The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.
void	setName(String name) The name of the map (data frame).
void	setSelectionColor(IColor color) The default selection color.
void	setSpatialReferenceByRef(ISpatialReference spatialReference) The spatial reference of the map (data frame).
void	setTransparentColor(IColor color) The color that is transparent (100 %).

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the map (data frame).

Product Availability

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

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

The name of the map (data frame).

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapArea

IMapArea getMapArea()
                    throws IOException,
                           AutomationException

The display area of the map (data frame).

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapArea

void setMapArea(IMapArea area)
                throws IOException,
                       AutomationException

The display area of the map (data frame).

Product Availability

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

Parameters:

area - A reference to a com.esri.arcgis.carto.IMapArea (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerDescriptions

ILayerDescriptions getLayerDescriptions()
                                        throws IOException,
                                               AutomationException

A collection of Layer Description objects, each describing a layer within the map (data frame).

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerDescriptions

void setLayerDescriptions(ILayerDescriptions layerDescriptions)
                          throws IOException,
                                 AutomationException

A collection of Layer Description objects, each describing a layer within the map (data frame).

Product Availability

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

Parameters:

layerDescriptions - A reference to a com.esri.arcgis.carto.ILayerDescriptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapRotation

double getMapRotation()
                      throws IOException,
                             AutomationException

The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.

Product Availability

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

Returns:

The angleDegrees

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMapRotation

void setMapRotation(double angleDegrees)
                    throws IOException,
                           AutomationException

The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.

Product Availability

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

Parameters:

angleDegrees - The angleDegrees (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the map (data frame).

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws IOException,
                                     AutomationException

The spatial reference of the map (data frame).

Product Availability

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

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomGraphics

IGraphicElements getCustomGraphics()
                                   throws IOException,
                                          AutomationException

Custom graphics.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomGraphics

void setCustomGraphics(IGraphicElements elements)
                       throws IOException,
                              AutomationException

Custom graphics.

Product Availability

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

Parameters:

elements - A reference to a com.esri.arcgis.carto.IGraphicElements (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparentColor

IColor getTransparentColor()
                           throws IOException,
                                  AutomationException

The color that is transparent (100 %).

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparentColor

void setTransparentColor(IColor color)
                         throws IOException,
                                AutomationException

The color that is transparent (100 %).

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionColor

IColor getSelectionColor()
                         throws IOException,
                                AutomationException

The default selection color.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionColor

void setSelectionColor(IColor color)
                       throws IOException,
                              AutomationException

The default selection color.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundSymbol

IFillSymbol getBackgroundSymbol()
                                throws IOException,
                                       AutomationException

Background symbol of the Map.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundSymbol

void setBackgroundSymbol(IFillSymbol fillSymbol)
                         throws IOException,
                                AutomationException

Background symbol of the Map.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHonorLayerReordering

boolean isHonorLayerReordering()
                               throws IOException,
                                      AutomationException

Indicates if this object's custom layer order is honored.

Remarks

When it is False, the order of LayerDescription objects in IMapDescription::LayerDescriptions array as well as any dynamically added LayerDesription object are ignored.

If you sent this value to True, then MapServer:

• honors the order of LayerDescription objects in LayerDescriptions array while drawing or identifying
• allows per-request addition of a new layer dynamically from registered workspace or removal of any existing layer.

Note: setting this value has no effect unless the IMapServerInfo::SupportsDynamicLayers is True by the author of that mapservice.

Warning: moving group layer may have unexpected result.

Product Availability

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

Returns:

The honorLayerReorder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHonorLayerReordering

void setHonorLayerReordering(boolean honorLayerReorder)
                             throws IOException,
                                    AutomationException

Indicates if this object's custom layer order is honored.

Product Availability

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

Parameters:

honorLayerReorder - The honorLayerReorder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.