com.esri.arcgis.carto
Interface IFind

All Superinterfaces:
Serializable
All Known Implementing Classes:
CadAnnotationLayer, CadFeatureLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, GdbRasterCatalogLayer, IFindProxy, MapServerFindSublayer, MapServerQuerySublayer, TemporalFeatureLayer

public interface IFind
extends Serializable

Provides access to members that control finding.

Remarks

IFind is a simple interface that can be used to search for a string in the attributes of Features of a layer. If the full Find dialog is needed, execute the appropriate Find command from esriControls instead.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IArray find(String search, boolean contains, Object fields, ITrackCancel trackCancel)
          Finds the specified search string in the given attribute fields.
 String getFindDisplayField()
          The display field.
 Object getFindFields()
          The attribute fields.
 

Method Detail

find

IArray find(String search,
            boolean contains,
            Object fields,
            ITrackCancel trackCancel)
            throws IOException,
                   AutomationException
Finds the specified search string in the given attribute fields.

Remarks

This method returns an reference to an Array of FeatureFindData objects. To search, pass in a reference to an Fields object along with the search string and a boolean option to return features that have attributes that contain the string. If Contains = False, only objects with an attribute that consists of the entire search string will be returned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
search - The search (in)
contains - The contains (in)
fields - A Variant (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFindFields

Object getFindFields()
                     throws IOException,
                            AutomationException
The attribute fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFindDisplayField

String getFindDisplayField()
                           throws IOException,
                                  AutomationException
The display field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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