com.esri.arcgis.controls
Interface IEngineInkEnvironmentEvents

All Superinterfaces:
EventListener, Serializable
All Known Implementing Classes:
IEngineInkEnvironmentEventsAdapter, IEngineInkEnvironmentEventsProxy

public interface IEngineInkEnvironmentEvents
extends EventListener, Serializable

Provides access to ink-related events.

Description

The IEngineInkEnvironmentEvents outbound interface is used to listen to Tablet events.

Note that OnGesture is supported on the Windows XP Tablet PC Edition only.

Product Availability

Available with ArcGIS Engine.


Method Summary
 void onGesture(IEngineInkEnvironmentEventsOnGestureEvent theEvent)
          Occurs when an ink gesture is made.
 void onStart(IEngineInkEnvironmentEventsOnStartEvent theEvent)
          Occurs when an ink collection is started.
 void onStop(IEngineInkEnvironmentEventsOnStopEvent theEvent)
          Occurs when an ink collection is halted.
 

Method Detail

onGesture

void onGesture(IEngineInkEnvironmentEventsOnGestureEvent theEvent)
               throws IOException,
                      AutomationException
Occurs when an ink gesture is made. Only available on TabletPC devices.

Description

Fired when an ink stroke is recognized as a gesture. The Ink tool uses ETPC_DownLeft to create graphic elements, ETPC_RightUp to recognize ink and create a text element, and ETPC_Scratchout to erase ink strokes. The ink tools can be extended by listening to OnGesture and responding to other gesture types that are exposed in ESRITPCGestures.

Note OnGesture is supported on the Windows XP Tablet PC Edition only.

Product Availability

Available with ArcGIS Engine.

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

onStart

void onStart(IEngineInkEnvironmentEventsOnStartEvent theEvent)
             throws IOException,
                    AutomationException
Occurs when an ink collection is started.

Description

Fired when ink collection starts.

Product Availability

Available with ArcGIS Engine.

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

onStop

void onStop(IEngineInkEnvironmentEventsOnStopEvent theEvent)
            throws IOException,
                   AutomationException
Occurs when an ink collection is halted.

Description

Fired when ink collection stops.

Product Availability

Available with ArcGIS Engine.

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