com.esri.arcgis.arcmapui
Interface IQueryAttributes

All Superinterfaces:

Serializable

All Known Implementing Classes:

QueryAttributes

public interface IQueryAttributes
extends Serializable

Provides access to members that control the Attribute query window.

Description

Use the IQueryAttributes interface to manage the attribute query dialog.
First set the Application property with a reference to the application.
Then you may set the other properties: the selection CombinationMethod, the Layer on which the selection will be performed and optionally the default query expression in Expression.

The SelectFeaturesInLayerOnOK specifies whether or not the selection will be performed when the user clicks Apply in the dialog and whether or not error messages will be shown. Setting it to true may be useful only if you want to use this dialog to get some input and process it in some way of your own.

Open the dialog with the DoModal method. If you need to open the dialog as modeless you may cast the IQueryAttributes into an ImodelessQueryAttributes and use its Show method.

On return, the QueryFilter property contains the expression actually used for the selection. The CombinationMethod and Layer are also updated with the user's choices

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	doModal(int parentHWnd) Shows attribute query window in a modal state.
int	getCombinationMethod() CombinationMethod on form.
ILayer	getLayer() Layer selected by the user.
IQueryFilter	getQueryFilter() Provide a QueryFilter after form has been executed.
void	setApplicationByRef(Object rhs1) Provides the window with a reference to the application.
void	setCombinationMethod(int pMethod) CombinationMethod on form.
void	setExpression(String rhs1) Default expression.
void	setLayerByRef(ILayer ppLayer) Layer selected by the user.
void	setSelectFeaturesInLayerOnOK(boolean rhs1) When the user presses OK, select features.

Method Detail

setApplicationByRef

void setApplicationByRef(Object rhs1)
                         throws IOException,
                                AutomationException

Provides the window with a reference to the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

void doModal(int parentHWnd)
             throws IOException,
                    AutomationException

Shows attribute query window in a modal state.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCombinationMethod

void setCombinationMethod(int pMethod)
                          throws IOException,
                                 AutomationException

CombinationMethod on form.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pMethod - A com.esri.arcgis.carto.esriSelectionResultEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCombinationMethod

int getCombinationMethod()
                         throws IOException,
                                AutomationException

CombinationMethod on form.

Remarks

The combination method defines how the selection performed will combine with an existing selection. It is the programmatic equivalent of the pulldown menus found in the selection dialogs in ArcMap.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.carto.esriSelectionResultEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer()
                throws IOException,
                       AutomationException

Layer selected by the user.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

void setLayerByRef(ILayer ppLayer)
                   throws IOException,
                          AutomationException

Layer selected by the user.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

ppLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectFeaturesInLayerOnOK

void setSelectFeaturesInLayerOnOK(boolean rhs1)
                                  throws IOException,
                                         AutomationException

When the user presses OK, select features. If there is an error, don't return. Default: FALSE.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

void setExpression(String rhs1)
                   throws IOException,
                          AutomationException

Default expression.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException

Provide a QueryFilter after form has been executed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.geodatabase.IQueryFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.