InteractiveService Class

Summary

Defines the service to translate mouse and touch events to common user interface interactions.

Syntax

C++

public class InteractiveService : IDisposable

Public Class InteractiveService

public ref class InteractiveService

Remarks

The InteractiveService object hooks to any control events and can be used to provide uniform tap, move, drag, hold, double tap, drag and pinch events. This can be done regardless of whether the platform supports mouse or touch events.

ImageViewer contains an instance of InteractiveService internally (accessible through the InteractiveService classes to perform rich interactive user interface interactions such as zoom, pan, scale, rubber banding and magnify glass.

To use the InteractiveService, call the Create method passing a control that will act as the events source (EventsSource). The events of this control will be subscribed to and converted from raw mouse and touch to the common events mentioned above. Also, the Create method takes another control that will act as the events target ( EventsTarget). This control is the target that will be used to check if the event is triggered on its surface. All coordinates will be translated based on its position. In the case of ImageViewer, the main control (the viewer control itself) will act as the events source and the foreground control (also the viewer control itself) will act as the events target. This insures that all events inside the viewer surface will act upon and translated into the control coordinates.

InteractiveService contains the following members:

Members	Description
Owner	The owner of the service. This is not used by InteractiveService but can be used by the application to pass any class and extra data. ImageViewer passes `this` for this parameter in the Create method.
EventsSource	The events source control.
EventsTarget	The events target control.
UserControls	Any extra controls that should participate in the events handling.
HitTestBuffer, TapOnDown, DragStartsOnDown, PinchStartsOnDown and EnableMouseWheel	Options used to modify the operations of the service.
StartListening, StopListening and IsListening	Subscribe/Unsubscribe to the events
Tap, DoubleTap, Move, Hold, DragStarted, DragDelta, DragCompleted, PinchStarted, PinchDelta and PinchCompleted	Uniform events for common user interface interaction regardless of the event source (mouse or touch)
KeyDown and KeyUp.	Keyboard events

Note that pinch events are not supported in the Windows Forms platform.

InteractiveService will subscribe to multiple native events. It is recommended if you create an instance of this object to call System.IDisposable.Dispose on it when you are done to free the resources used. ImageViewer will dispose its instance of InteractiveService when ImageViewer.Dispose is called.

Requirements

Target Platforms

Reference

InteractiveService Members

Leadtools.Controls Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Controls Assembly

Introduction

Getting Started

Namespaces

Leadtools.Controls Namespace

Assemblies