com.esri.arcgis.controls
Interface IARControlEvents

All Superinterfaces:
EventListener, Serializable
All Known Implementing Classes:
IARControlEventsAdapter, IARControlEventsProxy

public interface IARControlEvents
extends EventListener, Serializable

Provides access to events that occur with interaction to the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.


Method Summary
 void onAction(IARControlEventsOnActionEvent theEvent)
          Fires when an action takes place.
 void onAfterScreenDraw(IARControlEventsOnAfterScreenDrawEvent theEvent)
          Fires after the current map or page layout view redraws.
 void onBeforeScreenDraw(IARControlEventsOnBeforeScreenDrawEvent theEvent)
          Fires before the current map or page layout view redraws.
 void onCurrentViewChanged(IARControlEventsOnCurrentViewChangedEvent theEvent)
          Fires when the current view type is changed.
 void onDocumentLoaded(IARControlEventsOnDocumentLoadedEvent theEvent)
          Fires when a document is loaded into the control.
 void onDocumentUnloaded(IARControlEventsOnDocumentUnloadedEvent theEvent)
          Fires when a document is unloaded from the control.
 void onDoubleClick(IARControlEventsOnDoubleClickEvent theEvent)
          Fires when the user presses and releases any mouse button twice in quick succession, while over the current map or page layout view.
 void onFocusARMapChanged(IARControlEventsOnFocusARMapChangedEvent theEvent)
          Fires when the current focus map is changed to a new map.
 void onKeyDown(IARControlEventsOnKeyDownEvent theEvent)
          Fires after a key is pressed on the keyboard whilst the current map or page layout view has focus.
 void onKeyUp(IARControlEventsOnKeyUpEvent theEvent)
          Fires after a pressed key is released on the keyboard whilst the current map or page layout view has focus.
 void onMouseDown(IARControlEventsOnMouseDownEvent theEvent)
          Fires when the user presses any mouse button while over the current map or page layout view.
 void onMouseMove(IARControlEventsOnMouseMoveEvent theEvent)
          Fires when the user moves the mouse pointer over the current map or page layout view.
 void onMouseUp(IARControlEventsOnMouseUpEvent theEvent)
          Fires when the user releases any mouse button while over the current map or page layout view.
 

Method Detail

onMouseDown

void onMouseDown(IARControlEventsOnMouseDownEvent theEvent)
                 throws IOException,
                        AutomationException
Fires when the user presses any mouse button while over the current map or page layout view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onBeforeScreenDraw

void onBeforeScreenDraw(IARControlEventsOnBeforeScreenDrawEvent theEvent)
                        throws IOException,
                               AutomationException
Fires before the current map or page layout view redraws.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onAfterScreenDraw

void onAfterScreenDraw(IARControlEventsOnAfterScreenDrawEvent theEvent)
                       throws IOException,
                              AutomationException
Fires after the current map or page layout view redraws.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onDocumentLoaded

void onDocumentLoaded(IARControlEventsOnDocumentLoadedEvent theEvent)
                      throws IOException,
                             AutomationException
Fires when a document is loaded into the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onDocumentUnloaded

void onDocumentUnloaded(IARControlEventsOnDocumentUnloadedEvent theEvent)
                        throws IOException,
                               AutomationException
Fires when a document is unloaded from the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onFocusARMapChanged

void onFocusARMapChanged(IARControlEventsOnFocusARMapChangedEvent theEvent)
                         throws IOException,
                                AutomationException
Fires when the current focus map is changed to a new map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onCurrentViewChanged

void onCurrentViewChanged(IARControlEventsOnCurrentViewChangedEvent theEvent)
                          throws IOException,
                                 AutomationException
Fires when the current view type is changed.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onMouseUp

void onMouseUp(IARControlEventsOnMouseUpEvent theEvent)
               throws IOException,
                      AutomationException
Fires when the user releases any mouse button while over the current map or page layout view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onMouseMove

void onMouseMove(IARControlEventsOnMouseMoveEvent theEvent)
                 throws IOException,
                        AutomationException
Fires when the user moves the mouse pointer over the current map or page layout view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onDoubleClick

void onDoubleClick(IARControlEventsOnDoubleClickEvent theEvent)
                   throws IOException,
                          AutomationException
Fires when the user presses and releases any mouse button twice in quick succession, while over the current map or page layout view.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onKeyDown

void onKeyDown(IARControlEventsOnKeyDownEvent theEvent)
               throws IOException,
                      AutomationException
Fires after a key is pressed on the keyboard whilst the current map or page layout view has focus.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onKeyUp

void onKeyUp(IARControlEventsOnKeyUpEvent theEvent)
             throws IOException,
                    AutomationException
Fires after a pressed key is released on the keyboard whilst the current map or page layout view has focus.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

onAction

void onAction(IARControlEventsOnActionEvent theEvent)
              throws IOException,
                     AutomationException
Fires when an action takes place.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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