com.esri.arcgis.controls
Interface IARFeature

All Superinterfaces:
Serializable
All Known Implementing Classes:
ARFeature, IARFeatureProxy

public interface IARFeature
extends Serializable

Provides access to members that control the ARFeature.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.


Method Summary
 void centerAt()
          Centers the feature on the map display.
 void flash()
          Flashes the feature on the display.
 void flicker()
          Flickers the feature on the display.
 Object getCustomProperty()
          A property to associate data with an object.
 String getFieldAliasName(int index)
          The alias name of the field.
 int getFieldCount()
          The number of fields in the field collection.
 String getFieldName(int index)
          The name of the field.
 int getFieldType(int index)
          The type of field.
 Object getInternalObject()
          The internal ArcObjects IFeature object.
 Object getValue(Object index)
          The value of the field.
 String getValueAsString(Object index)
          A property to access the value of the specified field as a string.
 void highlight(boolean bHighlight, int color)
          Highlights the feature on the display.
 boolean isFieldAccessible(Object index)
          A property that checks if the specified field is accessible.
 void setCustomProperty(Object pVal)
          A property to associate data with an object.
 void zoomTo()
          Zooms the map to display the feature.
 

Method Detail

getValue

Object getValue(Object index)
                throws IOException,
                       AutomationException
The value of the field.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getFieldCount

int getFieldCount()
                  throws IOException,
                         AutomationException
The number of fields in the field collection.

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.

getFieldName

String getFieldName(int index)
                    throws IOException,
                           AutomationException
The name of the field.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
index - The index (in)
Returns:
The sName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldAliasName

String getFieldAliasName(int index)
                         throws IOException,
                                AutomationException
The alias name of the field.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
index - The index (in)
Returns:
The sAliasName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldType

int getFieldType(int index)
                 throws IOException,
                        AutomationException
The type of field.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.controls.esriARFieldType constant
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 feature.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

centerAt

void centerAt()
              throws IOException,
                     AutomationException
Centers the feature on the map display.

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 feature on the display.

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 feature on the display.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getInternalObject

Object getInternalObject()
                         throws IOException,
                                AutomationException
The internal ArcObjects IFeature object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Returns:
A reference to another Object (IUnknown)
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.

highlight

void highlight(boolean bHighlight,
               int color)
               throws IOException,
                      AutomationException
Highlights the feature on the display.

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.

isFieldAccessible

boolean isFieldAccessible(Object index)
                          throws IOException,
                                 AutomationException
A property that checks if the specified field is accessible.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
index - A Variant (in)
Returns:
The bAccessible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValueAsString

String getValueAsString(Object index)
                        throws IOException,
                               AutomationException
A property to access the value of the specified field as a string.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Parameters:
index - A Variant (in)
Returns:
The bsValueAsString
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.