com.esri.arcgis.carto
Interface IFeatureBookmark

All Superinterfaces:
ISpatialBookmark, Serializable
All Known Implementing Classes:
FeatureBookmark

public interface IFeatureBookmark
extends ISpatialBookmark, Serializable

Provides access to members that control a feature bookmark.

Remarks

The FeatureBookmark object is used to create a Feature bookmark.

To create a Feature bookmark in ArcMap, you would use the Identify tool, Identify a feature and use the Set Bookmark command in the context menu.

This object stores the ID of a feature and the feature class it belongs to in the FeatureID and FeatureClass properties. You can later find the bookmark by its name and display the corresponding feature.

IFeatureBookmark inherits from ISpatialBookmark .

To add bookmarks to the map, QueryInterface IMapBookMarks interface from IMap interface and then call the IMapBookmarks::AddBookMark method.

See also IAOIBookmark and the examples in the Carto library overview.

The Draw, Flash and PanTo methods are currently not implemented.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void draw(IDisplay display)
          Draws the feature on the map display.
 void flash(IDisplay display)
          Flashes the feature on the map display.
 IFeatureClass getFeatureClass()
          Feature class.
 int getFeatureId()
          Feature id.
 void panTo(IDisplay display)
          Pans to the feature on the map display.
 void setFeatureClass(IFeatureClass featureClass)
          Feature class.
 void setFeatureId(int fID)
          Feature id.
 
Methods inherited from interface com.esri.arcgis.carto.ISpatialBookmark
getBookmarkType, getName, setName, zoomTo
 

Method Detail

getFeatureId

int getFeatureId()
                 throws IOException,
                        AutomationException
Feature id.

Description

FeatureId is the OID associated with the selected feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setFeatureId

void setFeatureId(int fID)
                  throws IOException,
                         AutomationException
Feature id.

Description

FeatureId is the OID associated with the selected feature.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getFeatureClass

IFeatureClass getFeatureClass()
                              throws IOException,
                                     AutomationException
Feature class.

Description

FeatureClass is the IFeatureClass associated with the selected feature layer. The easiest way to get the selected layer is to use IMxDocument::Get_Selected layer. See example for further information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureClass

void setFeatureClass(IFeatureClass featureClass)
                     throws IOException,
                            AutomationException
Feature class.

Description

FeatureClass is the IFeatureClass associated with the selected feature layer. The easiest way to get the selected layer is to use IMxDocument::Get_Selected layer. See example for further information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

panTo

void panTo(IDisplay display)
           throws IOException,
                  AutomationException
Pans to the feature on the map display.

Description

PanTo the feature location specified by this bookmark. Not implemented at version 9.0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flash

void flash(IDisplay display)
           throws IOException,
                  AutomationException
Flashes the feature on the map display.

Description

Flash the shape of the bookmarked feature. Not implemented at version 9.0.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display)
          throws IOException,
                 AutomationException
Draws the feature on the map display.

Description

Draw the feature associated with the bookmark.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.