com.esri.arcgis.arcweb
Interface IArcWebMapImageOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcWebMapImageOptions

public interface IArcWebMapImageOptions
extends Serializable

Provides access to members used in finding routes and generating map images.

Product Availability

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

Method Summary

IColor	getBackgroundColor() The background color of the map image (default is Red).
int	getHeight() The height of the map image in pixels.
int	getWidth() The width of the map image in pixels.
void	setBackgroundColorByRef(IColor backgroundColor) The background color of the map image (default is Red).
void	setHeight(int height) The height of the map image in pixels.
void	setWidth(int width) The width of the map image in pixels.

Method Detail

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

The background color of the map image (default is Red).

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.

setBackgroundColorByRef

void setBackgroundColorByRef(IColor backgroundColor)
                             throws IOException,
                                    AutomationException

The background color of the map image (default is Red).

Product Availability

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

Parameters:

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

getHeight

int getHeight()
              throws IOException,
                     AutomationException

The height of the map image in pixels.

Product Availability

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

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

void setHeight(int height)
               throws IOException,
                      AutomationException

The height of the map image in pixels.

Product Availability

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

Parameters:

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth()
             throws IOException,
                    AutomationException

The width of the map image in pixels.

Product Availability

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

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(int width)
              throws IOException,
                     AutomationException

The width of the map image in pixels.

Product Availability

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

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.