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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.