com.esri.arcgis.carto
Interface IRasterFormatInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRasterFormatInfoProxy, RasterFormatInfo

public interface IRasterFormatInfo
extends Serializable

Provides access to members that provide basic information about a raster format.

Description

The IRasterFormatInfo interface exposes all of the format-specific raster defaults used in ArcMap and ArcCatalog.

The FormatName property specifies the name shown for this raster format. The other properties specify how ArcMap and ArcCatalog determine if a file is a raster dataset, when extension browsing is active.

The DefaultExts property specifies one or more comma-delimited file extensions that are used to filter for raster datasets of this format.

The ActiveBrowse property determines if ArcMap and ArcCatalog are currently scanning for datasets in this format.

Product Availability

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

Method Summary

String	getDefaultExts() Default format extensions.
String	getFormatName() Format name.
boolean	isActiveBrowse() Indicates whether all files are searched for valid raster formats.
void	setActiveBrowse(boolean pOpt) Indicates whether all files are searched for valid raster formats.
void	setDefaultExts(String ext) Default format extensions.
void	setFormatName(String name) Format name.

Method Detail

isActiveBrowse

boolean isActiveBrowse()
                       throws IOException,
                              AutomationException

Indicates whether all files are searched for valid raster formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pOpt

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveBrowse

void setActiveBrowse(boolean pOpt)
                     throws IOException,
                            AutomationException

Indicates whether all files are searched for valid raster formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pOpt - The pOpt (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormatName

String getFormatName()
                     throws IOException,
                            AutomationException

Format name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormatName

void setFormatName(String name)
                   throws IOException,
                          AutomationException

Format name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultExts

String getDefaultExts()
                      throws IOException,
                             AutomationException

Default format extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The ext

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultExts

void setDefaultExts(String ext)
                    throws IOException,
                           AutomationException

Default format extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ext - The ext (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.