com.esri.arcgis.catalog
Interface IGxFileFilter

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxFileFilter

public interface IGxFileFilter
extends Serializable

Provides access to members that manage a file filter for various file types.

Description

The GxFileFilter object implements the IGxFileFilter interface. It lets you manipulate the file types displayed by ArcCatalog. Through this interface, you can add additional file types to the filter, remove file types, and determine whether or not a particular file will be displayed.

The Filter method returns a Boolean that indicates whether or not the specified file will be displayed in ArcCatalog based on the current file filter.

The FindFileType method returns an index that indicates the position of the specified file extension within the filter list. A value of -1 indicates the extension was not found. Do not include the “.” when passing in the extension.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addFileType(String extension, String description, String filePathImage) Add the file type to the collection.
void	deleteFileType(int index) Remove the file type.
boolean	filter(String filePath) Checks to see if the indicated file passes the filter.
int	findFileType(String extension) The index of the file type in the filter or -1.
void	getFileType(int index, String[] extension, String[] description, String[] imageFile, int[] smallBitmap, int[] largeBitmap) Returns information on the file type at the specified index in the file filter.
int	getFileTypeCount() The number of file types for the filter.

Method Detail

filter

boolean filter(String filePath)
               throws IOException,
                      AutomationException

Checks to see if the indicated file passes the filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

filePath - The filePath (in)

Returns:

The passesFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findFileType

int findFileType(String extension)
                 throws IOException,
                        AutomationException

The index of the file type in the filter or -1.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

extension - The extension (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileTypeCount

int getFileTypeCount()
                     throws IOException,
                            AutomationException

The number of file types for the filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileType

void getFileType(int index,
                 String[] extension,
                 String[] description,
                 String[] imageFile,
                 int[] smallBitmap,
                 int[] largeBitmap)
                 throws IOException,
                        AutomationException

Returns information on the file type at the specified index in the file filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

index - The index (in)

extension - The extension (out: use single element array)

description - The description (out: use single element array)

imageFile - The imageFile (out: use single element array)

smallBitmap - The smallBitmap (A COM typedef) (out: use single element array)

largeBitmap - The largeBitmap (A COM typedef) (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFileType

void addFileType(String extension,
                 String description,
                 String filePathImage)
                 throws IOException,
                        AutomationException

Add the file type to the collection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

extension - The extension (in)

description - The description (in)

filePathImage - The filePathImage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteFileType

void deleteFileType(int index)
                    throws IOException,
                           AutomationException

Remove the file type.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.