com.esri.arcgis.carto
Interface IMapServerLayer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMapServerLayerProxy, MapServerLayer

public interface IMapServerLayer
extends java.io.Serializable

COM Interface 'IMapServerLayer'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the available properties of a map server layer object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDe9b56157_7eb7_4db3_9958_afbf3b5e1470
static int	xxDummy Deprecated. Internal use only

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, java.lang.String[] docLocation, java.lang.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(java.lang.String docLocation, java.lang.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, java.lang.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 %).

Field Detail

IIDe9b56157_7eb7_4db3_9958_afbf3b5e1470

static final int IIDe9b56157_7eb7_4db3_9958_afbf3b5e1470

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

localConnect

void localConnect(java.lang.String docLocation,
                  java.lang.String mapName)
                  throws java.io.IOException,
                         AutomationException

Connects to map document data frame specified by the location of a map document and the name of a data frame.

Parameters:

docLocation - The docLocation (in)

mapName - The mapName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serverConnect

void serverConnect(IAGSServerObjectName soName,
                   java.lang.String mapName)
                   throws java.io.IOException,
                          AutomationException

Connects to map server object specified by the AGSServerObject name for a MapServer server object and the name of a data frame.

Parameters:

soName - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

mapName - The mapName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionInfo

void getConnectionInfo(IAGSServerObjectName[] soName,
                       java.lang.String[] docLocation,
                       java.lang.String[] mapName)
                       throws java.io.IOException,
                              AutomationException

Returns information about a connection to a map server object or to a map document.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearDrawCache

void clearDrawCache()
                    throws java.io.IOException,
                           AutomationException

Clears the cache of images downloaded from the server redraw.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

The background color of a map server layer object.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparentColor

IColor getTransparentColor()
                           throws java.io.IOException,
                                  AutomationException

The color that is transparent (100 %).

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparentColor

void setTransparentColor(IColor color)
                         throws java.io.IOException,
                                AutomationException

The color that is transparent (100 %).

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.