com.esri.arcgis.controls
Interface IARFeatureSet

All Superinterfaces:

Serializable

All Known Implementing Classes:

ARFeatureSet, IARFeatureSetProxy

public interface IARFeatureSet
extends Serializable

Provides access to members that control the ARFeatureSet.

Description

The IARFeatureSet interface is a starting point for enumerating ARFeature objects. An ARFeatureSet is returned from the IARMap::QueryARFeatures and IARLayer::QueryARFeatures methods. An ARFeatureSet allows ARFeature objects to be returned all at once; this is useful if there are a small number of ARFeature objects, as an ARFeatureSet can consume a lot of memory and take a long time to be populated.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Method Summary

void	centerAt() Centers the map display on the center of the ARFeatureSet.
void	flash() Flashes the features in the ARFeatureSet.
void	flicker() Flickers the features in the ARFeatureSet.
IARFeature	getARFeature(int index) The feature at the specified index.
int	getARFeatureCount() The number of features in the ARFeatureSet.
Object	getCustomProperty() A property to associate data with an object.
void	highlight(boolean bHighlight, int color) Highlights the features in the ARFeatureSet.
IARFeature	next() Retrieves the next feature in the ARFeatureSet.
void	reset() Resets the ARFeatureSet to the beginning.
void	setCustomProperty(Object pVal) A property to associate data with an object.
void	zoomTo() Zooms the map to display the ARFeatureSet.

Method Detail

getARFeatureCount

int getARFeatureCount()
                      throws IOException,
                             AutomationException

The number of features in the ARFeatureSet.

Description

The ARFeatureCount property returns the number of ARFeature's within the ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

The lCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARFeature

IARFeature getARFeature(int index)
                        throws IOException,
                               AutomationException

The feature at the specified index.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.controls.IARFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

IARFeature next()
                throws IOException,
                       AutomationException

Retrieves the next feature in the ARFeatureSet.

Description

The Next method advances the ARFeatureSet by one, and returns the ARFeature object at that position.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

A reference to a com.esri.arcgis.controls.IARFeature

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the ARFeatureSet to the beginning.

Description

Resets the ARFeatureSet to the beginning. To make subsequent passes through the ARFeatureSet use the Reset method to go back to the first ARFeature in the collection.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

Object getCustomProperty()
                         throws IOException,
                                AutomationException

A property to associate data with an object.

Description

Use the CustomProperty to associate any useful data with the ARFeatureSet. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException

A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

centerAt

void centerAt()
              throws IOException,
                     AutomationException

Centers the map display on the center of the ARFeatureSet.

Description

Centers the extent of all the features in the ARFeatureSet on the display to make them visible. The extent of the ARMap will change, but the IARMap::MapScale will remain the same. By default the screen is automatically refreshed.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flash

void flash()
           throws IOException,
                  AutomationException

Flashes the features in the ARFeatureSet.

Description

Flashes all the features in the ARFeatureSet once on the display. The greater the ARFeatureCount, the longer it will take to flash the features. Before using the Flash method use the ZoomTo or CenterAt method to ensure that the ARFeature is visible in the ARMap display area to the user.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

flicker

void flicker()
             throws IOException,
                    AutomationException

Flickers the features in the ARFeatureSet.

Description

Flickers all the features in the ARFeatureSet on the display. This is like flashing the features four times in quick succession. The greater the ARFeatureCount, the longer it will take to flicker the features. Before using the Flicker method use the ZoomTo or CenterAt method to ensure that the ARFeature is visible in the ARMap display area to the user.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomTo

void zoomTo()
            throws IOException,
                   AutomationException

Zooms the map to display the ARFeatureSet.

Description

Zooms to the extent of all the features in the ARFeatureSet to make them visible on the display. This may change the IARMap::MapScale. By default the screen is automatically refreshed.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

highlight

void highlight(boolean bHighlight,
               int color)
               throws IOException,
                      AutomationException

Highlights the features in the ARFeatureSet.

Description

Highlights all the features in the ARFeatureSet on the display. By deafult the screen is automatically refreshed.

Remarks

This method acts on an instance of an object. In order to toggle the highlighting of an ARFeatureSet, one must work with the same instance of the object.

The Highlight method triggers the following events:

OnBeforeScreenDraw
OnAfterScreenDraw

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:

bHighlight - The bHighlight (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.