|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IMapServerLayer
Provides access to the available properties of a map server layer object.
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 |
---|
void localConnect(String docLocation, String mapName) throws IOException, AutomationException
docLocation
- The docLocation (in)mapName
- The mapName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void serverConnect(IAGSServerObjectName soName, String mapName) throws IOException, AutomationException
soName
- A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)mapName
- The mapName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void getConnectionInfo(IAGSServerObjectName[] soName, String[] docLocation, String[] mapName) throws IOException, AutomationException
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.
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void clearDrawCache() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IColor getBackgroundColor() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IColor getTransparentColor() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setTransparentColor(IColor color) throws IOException, AutomationException
color
- A reference to a com.esri.arcgis.display.IColor (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |