com.esri.arcgis.carto
Interface IMapServerLayer

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServerLayer

public interface IMapServerLayer
extends Serializable

Provides access to the available properties of a map server layer object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void clearDrawCache()
          Clears the cache of images downloaded from the server redraw.
 IColor getBackgroundColor()
          The background color of a map server layer object.
 void getConnectionInfo(IAGSServerObjectName[] soName, String[] docLocation, String[] mapName)
          Returns information about a connection to a map server object or to a map document.
 IColor getTransparentColor()
          The color that is transparent (100 %).
 void localConnect(String docLocation, String mapName)
          Connects to map document data frame specified by the location of a map document and the name of a data frame.
 void serverConnect(IAGSServerObjectName soName, String mapName)
          Connects to map server object specified by the AGSServerObject name for a MapServer server object and the name of a data frame.
 void setTransparentColor(IColor color)
          The color that is transparent (100 %).
 

Method Detail

localConnect

void localConnect(String docLocation,
                  String mapName)
                  throws IOException,
                         AutomationException
Connects to map document data frame specified by the location of a map document and the name of a data frame.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
docLocation - The docLocation (in)
mapName - The mapName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serverConnect

void serverConnect(IAGSServerObjectName soName,
                   String mapName)
                   throws IOException,
                          AutomationException
Connects to map server object specified by the AGSServerObject name for a MapServer server object and the name of a data frame.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
soName - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)
mapName - The mapName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConnectionInfo

void getConnectionInfo(IAGSServerObjectName[] soName,
                       String[] docLocation,
                       String[] mapName)
                       throws IOException,
                              AutomationException
Returns information about a connection to a map server object or to a map document.

Remarks

If the connection is to a MapServer object, the GetConnectionInfo method returns the AGSServerObjectName and the name of the data frame. If the connection is made to a map document (.mxd of .pmf), this method returns the location of the map document and the name of the data frame.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
soName - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (out: use single element array)
docLocation - The docLocation (out: use single element array)
mapName - The mapName (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearDrawCache

void clearDrawCache()
                    throws IOException,
                           AutomationException
Clears the cache of images downloaded from the server redraw.

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.

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException
The background color of a map server layer object.

Remarks

Use BackgroundColor to retrieve the color for the background of a map server layer object. The BackgroundColor of a map server layer is transparent by default when it is added to an application.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getTransparentColor

IColor getTransparentColor()
                           throws IOException,
                                  AutomationException
The color that is transparent (100 %).

Remarks

Setting a transparent color is valid only for formats that support transparency. These include: png, png24 and gif. When adding a MapServerLayer to ArcMap the TransparentColor value is equal to the value of the BackgroundColor. Therefore, the background is transparent by default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

Supported Platforms

Windows, Solaris, Linux

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.