com.esri.arcgis.editor
Interface IObjectInspector

All Superinterfaces:
Serializable
All Known Implementing Classes:
DimensionInspector, FeatureInspector, RepresentationInspector

public interface IObjectInspector
extends Serializable

Provides access to members that control a custom feature's property inspector.

Description

The IObjectInspector interface is an optional interface that provides the ability to replace the ArcMap editorís default ObjectInspector with a custom one.

Remarks

In order to create a custom feature inspector, both the IObjectInspector and IClassExtension interfaces must be implemented.

This diagram shows the portion of the Object Inspector that is customizable:



Use the hWnd property to set the control you want to display in the customizable area. You can then customize the actions of the Feature Inspector using the Inspect method. This method is called whenever a feature class or feature is clicked in the Tree View.

When To Use

If you extend a feature class with custom properties, you may want to implement the IObjectInspector interface so that you can display and edit those properties using the Attributes Dialog located on the Editor toolbar.

Product Availability

Available with ArcGIS Desktop.

See Also:
com.esri.arcgis.editor.IShortTransactionObjectInspector

Method Summary
 void clear()
          Clear the inspector before inspecting another object.
 void copy(IRow srcRow)
          Copies the values from srcRow to the row being edited.
 int getHWND()
          The window handle for the inspector.
 void inspect(IEnumRow objects, IEditor editor)
          Inspects the properties of the features.
 

Method Detail

getHWND

int getHWND()
            throws IOException,
                   AutomationException
The window handle for the inspector.

Remarks

The Object Inpector reads this property to determine what it will display in its right pane. Custom Object Inspectors must supply the hWnd property of the window or control that is going to be displayed.



Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
The hWND (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

inspect

void inspect(IEnumRow objects,
             IEditor editor)
             throws IOException,
                    AutomationException
Inspects the properties of the features.

Remarks

Use the Inspect method to display your custom Feature Inspector.

The Inspect method provides you with an enumeration of row objects to inspect as well as a pointer to the Editor extension. Use the row enumeration to retrieve properties of a feature. Then you can use the Editor object reference to modify properties of a row within the context of an edit operation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

clear

void clear()
           throws IOException,
                  AutomationException
Clear the inspector before inspecting another object.

Remarks

Use the Clear property to reset your custom Feature Inspector control(s). The Clear property is called prior to updating the Inspect property with a new row enumeration.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

copy

void copy(IRow srcRow)
          throws IOException,
                 AutomationException
Copies the values from srcRow to the row being edited.

Remarks

Use the Copy property to get rows that have been copied using the context menu in the tree control of the Attributes Dialog located on the Editor Toolbar.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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