com.esri.arcgis.arcmapui
Interface IFindCallBack

All Superinterfaces:

Serializable

All Known Implementing Classes:

IFindCallBackProxy

public interface IFindCallBack
extends Serializable

Provides access to members that control the results in a custom find dialog page.

Remarks

See the IFinder interface for documentation and an example (VB6) of use.

Performing a search with a Find tab will typically return an array of features used to populate the result list that automatically appears at the bottom of the dialog. Populating this list is done with the IFindCallBack and IFeatureFindData interfaces.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addNewRow() Adds a new row to the listbox, using values set with ColumnValue.
void	flashGeometry(IGeometry pGeometry, int nTimes, boolean bCoolFlash) Generic method to flash a point on the display n times.
IApplication	getApplication() The application that this dialog belongs to.
int	getColumnCount() Number of columns to display in list box.
void	processMessages(boolean[] quitProcessing) Processes messages.
void	setColumnValue(int column, String rhs2) Rows column value in listbox.
void	setObjectByRef(Object rhs1) The object value of the new row.

Method Detail

getApplication

IApplication getApplication()
                            throws IOException,
                                   AutomationException

The application that this dialog belongs to.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.framework.IApplication

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectByRef

void setObjectByRef(Object rhs1)
                    throws IOException,
                           AutomationException

The object value of the new row. This object is passed to the popup menu in an ISet.

Description

The object to show as a new row in the value list. Typically an IFeatureFindData.

Remarks

A reference to a feature

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColumnValue

void setColumnValue(int column,
                    String rhs2)
                    throws IOException,
                           AutomationException

Rows column value in listbox.

Product Availability

Available with ArcGIS Desktop.

Parameters:

column - The column (in)

rhs2 - The rhs2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException

Number of columns to display in list box.

Description

The number of columns in the value list.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The columnCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addNewRow

void addNewRow()
               throws IOException,
                      AutomationException

Adds a new row to the listbox, using values set with ColumnValue.

Description

Adds a new row to the value list. Should be called once the properties of this interface and IFeatureFindData have been properly initialized.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

processMessages

void processMessages(boolean[] quitProcessing)
                     throws IOException,
                            AutomationException

Processes messages. Run this method often.

Description

Optionally call this method in the loop adding features to the value list of the Find dialog and stop populating the list when it returns false to give the user a chance to interrupt the process.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flashGeometry

void flashGeometry(IGeometry pGeometry,
                   int nTimes,
                   boolean bCoolFlash)
                   throws IOException,
                          AutomationException

Generic method to flash a point on the display n times.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

nTimes - The nTimes (in)

bCoolFlash - The bCoolFlash (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.