com.esri.arcgis.datasourcesraster
Interface IRasterThumbnailBuilder

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterThumbnailBuilder

public interface IRasterThumbnailBuilder
extends Serializable

Provides access to members that control a raster thumbnail builder.

Product Availability

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

Method Summary

byte[]	buildThumbnail(IItemURI pItemURI, IRaster pRaster) Renders and returns a thumbnail (as an of bytes in the requested format) associated with the specified item URI and the corresponding raster.
String	getThumbnailFormat() The format string defining the layout of the byte array used for encoding the thumbnail pixels.
void	setThumbnailFormat(String pThumbnailFormat) The format string defining the layout of the byte array used for encoding the thumbnail pixels.

Method Detail

setThumbnailFormat

void setThumbnailFormat(String pThumbnailFormat)
                        throws IOException,
                               AutomationException

The format string defining the layout of the byte array used for encoding the thumbnail pixels.

Product Availability

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

Parameters:

pThumbnailFormat - The pThumbnailFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnailFormat

String getThumbnailFormat()
                          throws IOException,
                                 AutomationException

The format string defining the layout of the byte array used for encoding the thumbnail pixels.

Product Availability

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

Returns:

The pThumbnailFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

buildThumbnail

byte[] buildThumbnail(IItemURI pItemURI,
                      IRaster pRaster)
                      throws IOException,
                             AutomationException

Renders and returns a thumbnail (as an of bytes in the requested format) associated with the specified item URI and the corresponding raster.

Product Availability

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

Parameters:

pItemURI - A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.