com.esri.arcgis.controls
Interface IEngineObjectInspector

All Superinterfaces:

Serializable

All Known Implementing Classes:

EngineFeatureInspector, IEngineObjectInspectorProxy

public interface IEngineObjectInspector
extends Serializable

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

Description

This interface is new at ArcGIS 9.3.

The IEngineObjectInspector interface is an optional interface that provides the ability to replace the default ObjectInspector with a custom one.

If you extend a feature class with custom properties, you may want to implement the IEngineObjectInspector interface so that you can display and edit those properties using the ControlsEditingAttributeCommand.

Remarks

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

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.

Product Availability

Available with ArcGIS Engine.

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(IEngineEnumRow objects, IEngineEditor editor) Inspects the properties of the features.

Method Detail

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException

The window handle for the inspector.

Description

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 Engine.

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

inspect

void inspect(IEngineEnumRow objects,
             IEngineEditor editor)
             throws IOException,
                    AutomationException

Inspects the properties of the features.

Description

Use this 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 EngineEditor singleton object. Use the row enumeration to retrieve properties of a feature. Then you can use the EngineEditor object reference to modify properties of a row within the context of an edit operation.

Product Availability

Available with ArcGIS Engine.

Parameters:

objects - A reference to a com.esri.arcgis.controls.IEngineEnumRow (in)

editor - A reference to a com.esri.arcgis.controls.IEngineEditor (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.

Description

Use this 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 Engine.

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.

Description

Use this property to get rows that have been copied using the context menu in the tree control of the Attributes Dialog.

Product Availability

Available with ArcGIS Engine.

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.