com.esri.arcgis.carto
Interface IMapCacheToRasterFunctionArgument

All Superinterfaces:

Serializable

All Known Implementing Classes:

IMapCacheToRasterFunctionArgumentProxy

public interface IMapCacheToRasterFunctionArgument
extends Serializable

Provides access to members that control a map cache to raster function.

Product Availability

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

Method Summary

IColor	getBackgroundColor() Set the background color.
ITable	getCacheDataTable() Set the cache data table.
String	getCacheLocation() Set the cache location.
ITable	getCacheTable() Set the cache table.
IEnvelope	getExtent() Set the cache extent.
IColor	getTransparentColor() Set the transparent color.
void	setBackgroundColorByRef(IColor ppBackgroundColor) Set the background color.
void	setCacheDataTableByRef(ITable ppCacheDataTable) Set the cache data table.
void	setCacheLocation(String pCachePath) Set the cache location.
void	setCacheTableByRef(ITable ppCacheTable) Set the cache table.
void	setExtentByRef(IEnvelope ppEnvelope) Set the cache extent.
void	setTransparentColorByRef(IColor ppTransparentColor) Set the transparent color.

Method Detail

setCacheLocation

void setCacheLocation(String pCachePath)
                      throws IOException,
                             AutomationException

Set the cache location.

Product Availability

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

Parameters:

pCachePath - The pCachePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheLocation

String getCacheLocation()
                        throws IOException,
                               AutomationException

Set the cache location.

Product Availability

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

Returns:

The pCachePath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

void setExtentByRef(IEnvelope ppEnvelope)
                    throws IOException,
                           AutomationException

Set the cache extent.

Product Availability

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

Parameters:

ppEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

Set the cache extent.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheTableByRef

void setCacheTableByRef(ITable ppCacheTable)
                        throws IOException,
                               AutomationException

Set the cache table.

Product Availability

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

Parameters:

ppCacheTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheTable

ITable getCacheTable()
                     throws IOException,
                            AutomationException

Set the cache table.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheDataTableByRef

void setCacheDataTableByRef(ITable ppCacheDataTable)
                            throws IOException,
                                   AutomationException

Set the cache data table.

Product Availability

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

Parameters:

ppCacheDataTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheDataTable

ITable getCacheDataTable()
                         throws IOException,
                                AutomationException

Set the cache data table.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColorByRef

void setBackgroundColorByRef(IColor ppBackgroundColor)
                             throws IOException,
                                    AutomationException

Set the background color.

Product Availability

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

Parameters:

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

getBackgroundColor

IColor getBackgroundColor()
                          throws IOException,
                                 AutomationException

Set the background 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.

setTransparentColorByRef

void setTransparentColorByRef(IColor ppTransparentColor)
                              throws IOException,
                                     AutomationException

Set the transparent color.

Product Availability

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

Parameters:

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

getTransparentColor

IColor getTransparentColor()
                           throws IOException,
                                  AutomationException

Set the transparent 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.