 |
This document is archived and information here might be outdated. Recommended version. |
IObjectClassEvents Interface (ArcObjects .NET 10.6 SDK)
|
This document is archived and information here might be outdated. Recommended version. |
Provides access to events that occur with an object class.
IObjectClassEvents is an optional interface for class extensions, as well as an event interface for object classes. Both techniques allow the capture of events that occur in the object class, such as object creation, modification and deletion.
Implementing IObjectClassEvents allows for the building of ClassExtensions which is an ideal way to extend the default geodatabase behavior. This type of extension can be used when you don't want to rely on catching IEditEvents such as OnCreateFeature, OnChangeFeature or OnDeleteFeature. This is handy when you need to implement a geodatabase-level customization that will not be application specific, i.e. dependent upon ArcMap and the Editor extension.
Any custom object can listen to the IObjectClassEvents event interface.
| Name | Description | |
|---|---|---|
 |
OnChange | This event is fired when an object's attributes or geometry is updated. |
|
OnCreate | This event is fired when a new object is created in the object class. |
|
OnDelete | This event is fired when an object is deleted from the object class. |
| CoClasses and Classes | Description |
|---|---|
| AnnotationFeatureClassExtension (esriCarto) | An Esri annotation feature class extension. |
| AnnotationInspector (esriEditor) | A property inspector for annotation features. |
| DimensionClassExtension (esriCarto) | A class extension which contains all the style properties for a dimension feature class. |
| DimensionInspector (esriEditor) | A property inspector for dimension features. |
| FDOGraphicsLayer (esriCarto) | A collection of properties for an annotation layer (feature data object graphics layer). |
| FeatureInspector (esriEditor) | Default feature inspector for the Editor. |
| FeatureSnap (esriEditor) | Snap agent that snaps to a feature in a specified way. |
| GdbRasterCatalogLayer (esriCarto) | Geodabase RasterCatalog source and display options. |
| GxRasterCatalogContentView (esriCatalogUI) | The RasterCatalog content view. |
| NAWindow (esriNetworkAnalystUI) | The network analysis window. |
| ObjectClassEvents | Helper coclass for working with the outbound interface on noncreatable object classes in VB. |
| ObjectClassEventsListener (esriSystemUtility) | Helper coclass to provide IObjectClassEvents support to the C++ API. |
| RelQueryTable | An object that joins two datasets based on common data values. |
| RouteEventSource (esriLocation) | Route event source object. |
| TopologyExtension (esriEditorExt) | Extension for working with topology. |
| XYEventSource | XY event source object. |
Listeners of the OnCreate event are not necessarily notified every time an object is created. The event is triggered following a call to IRow.Store, and by default this does not occur when objects or simple features are created using an insert cursor. This can be overridden by setting the IWorkspaceEditControl.SetStoreEventsRequired property to true, or by implementing the optional IObjectClassInfo interface on the class' extension.
If you are using the OnCreate, OnDelete or OnChange methods in a class extension to validate edit operations, you should not call AbortEditOperation on the workspace if your logic indicates that the edit operation is invalid. Instead, raise an error which will be propagated to the application that is performing the edit on the class.
It is the responsibility of the editing application that receives the error to abort the edit operation. This is especially true when editing with ArcMap. If you call AbortEditOperation from within the class extension, the ArcMap undo/redo edit stack will become out of sync.
In the event that a feature should be deleted due to an OnChange event, it is not recommended that the event handler delete the feature itself. Instead, an exception should be thrown to the application, where it can be made responsible for deleting the feature.
The OnCreate, OnDelete or OnChange events are not fired during a Topology Validation. The OnCreate and OnDelete events are not applicable since a Validate does not create or delete features. The OnChange event is not fired for performance as a large number of features may be changed during a Validate. In addition, features may be changed many times.