com.esri.arcgis.carto
Interface IRasterDefaultsEnv2

All Superinterfaces:
IRasterDefaultsEnv, Serializable
All Known Subinterfaces:
IRasterDefaultsEnv3, IRasterDefaultsEnv4
All Known Implementing Classes:
RasterDefaultsEnv

public interface IRasterDefaultsEnv2
extends IRasterDefaultsEnv, Serializable

Provides access to members that control the default raster environment.

Superseded By

IRasterDefaultsEnv4

When To Use

The IRasterDefaultsEnv2 interface controls all of the common raster default properties of IRasterDefaultsEnv and four additional functions that customize other raster behavior.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getMaxTableSize()
          Default maximum table size.
 String getProxyFilePath()
          Default proxy file path.
 int getRenderingMode()
          Default rendering mode.
 int getResampling()
          Default resampling for display.
 void setMaxTableSize(int pMaxTableSize)
          Default maximum table size.
 void setProxyFilePath(String pProxyFilePath)
          Default proxy file path.
 void setRenderingMode(int pRenderingMode)
          Default rendering mode.
 void setResampling(int pDefaultResampling)
          Default resampling for display.
 void updateAll()
          Updates the registry with all changes to the raster environment in the current session.
 
Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv
getFormat, getNumFormats, getPyramidCreateOpt, isUseExtChecking, query3BandRGB, query4BandRGB, set3BandRGB, set4BandRGB, setPyramidCreateOpt, setUseExtChecking
 

Method Detail

setRenderingMode

void setRenderingMode(int pRenderingMode)
                      throws IOException,
                             AutomationException
Default rendering mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pRenderingMode - A com.esri.arcgis.carto.esriRasterRenderingModeEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRenderingMode

int getRenderingMode()
                     throws IOException,
                            AutomationException
Default rendering mode.

Description

The RenderingMode property specifies the drawing mode used when displaying a raster dataset. The full option waits until the entire raster has been drawn to a backing store, then displays it to the screen at once.

Block mode draws the raster one block at a time, starting at the upper left and progressing left to right and then down. Top-to-bottom mode begins at the top and draws a few lines at a time as it progresses down the screen.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriRasterRenderingModeEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResampling

void setResampling(int pDefaultResampling)
                   throws IOException,
                          AutomationException
Default resampling for display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pDefaultResampling - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResampling

int getResampling()
                  throws IOException,
                         AutomationException
Default resampling for display.

Description

The Resampling property controls the default resampling technique used when a raster is first displayed. Single-band rasters are displayed using the stretched renderer or unique value renderer by default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.rstResamplingTypes constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProxyFilePath

void setProxyFilePath(String pProxyFilePath)
                      throws IOException,
                             AutomationException
Default proxy file path.

Remarks

The ProxyFilePath property controls the directory location where these proxy files, as well as any auxiliary or pyramid files for these datasets, are located. This property can only be set by users with Administrator access to their computer. The rest of these properties control the appearance of raster datasets when first viewed in ArcGIS.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getProxyFilePath

String getProxyFilePath()
                        throws IOException,
                               AutomationException
Default proxy file path.

Remarks

This method is used to set the path for proxy files, e.g. files generated in the local proxy folder when accessing read only raster datasets. This applies to ArcGIS 9.1 and older version only.

ArcGIS 9.2 always use Windows system default temp folder for writting proxy files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pProxyFilePath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxTableSize

void setMaxTableSize(int pMaxTableSize)
                     throws IOException,
                            AutomationException
Default maximum table size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaxTableSize

int getMaxTableSize()
                    throws IOException,
                           AutomationException
Default maximum table size.

Remarks

If a dataset has more entries in its table then the MaxTableSize property, it will be displayed by default using the stretched renderer. A dataset with fewer unique values than this threshold will display using the unique value renderer. This value is 25 by default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pMaxTableSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateAll

void updateAll()
               throws IOException,
                      AutomationException
Updates the registry with all changes to the raster environment in the current session.

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.