C1DragHelper Constructor

Initializes a new C1DragHelper.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function New( _
   ByVal element As UIElement, _
   Optional ByVal mode As C1DragHelperMode, _
   Optional ByVal initialThreshold As Double, _
   Optional ByVal captureElementOnPointerPressed As Boolean, _
   Optional ByVal handledEventsToo As Boolean, _
   Optional ByVal useManipulationEvents As Boolean, _
   Optional ByVal useRightButton As Boolean _
)

'Usage
 
Dim element As UIElement
Dim mode As C1DragHelperMode
Dim initialThreshold As Double
Dim captureElementOnPointerPressed As Boolean
Dim handledEventsToo As Boolean
Dim useManipulationEvents As Boolean
Dim useRightButton As Boolean
 
Dim instance As New C1DragHelper(element, mode, initialThreshold, captureElementOnPointerPressed, handledEventsToo, useManipulationEvents, useRightButton)

public C1DragHelper( 
   UIElement element,
   C1DragHelperMode mode,
   double initialThreshold,
   bool captureElementOnPointerPressed,
   bool handledEventsToo,
   bool useManipulationEvents,
   bool useRightButton
)

public:
C1DragHelper( 
   UIElement^ element,
   C1DragHelperMode mode,
   double initialThreshold,
   bool captureElementOnPointerPressed,
   bool handledEventsToo,
   bool useManipulationEvents,
   bool useRightButton
)

Parameters

element: An System.Windows.UIElement on which the drag gesture will be listened.
mode: Indicates the sort of drag to be listened. Combine inertia flag with other flags so that DragDelta events are raised after the manipulation finish. i.e. C1DragHelperMode.FreeDrag | C1DragHelperMode.Inertia
initialThreshold: Specifies the number of pixels the gesture will have to pass in order to start. if 0 is set the gesture will start on pointer down, and captureElementOnPointerPressed will be true despite the specified parameter, otherwise the gesture will start on mouse move, default value is 1
captureElementOnPointerPressed: Indicates whether the element will be captured in pointer pressed event (MouseLeftButtonDown in SL and WPF and PointerPressed in WinRT) or in the first pointer move event (MouseMove in SL and WPF and PointerMoved in WinRT). If initialThreshold is 0 this parameter will be ignored.Capturing the element on mouse down will cause Click, DoubleClick and MouseLeftButtonUp events not to be fired in sub-elements (nested elements in the visual tree), whereas capturing the element on the first mouse move can make it difficult for final users to drag small elements quickly.
handledEventsToo: Indicates whether drag gestures will be listened despite mouse events were already handled. (It only applies to mouse gestures)
useManipulationEvents: When set to true it uses Manipulation events to listen to the gesture, otherwise itwill use Pointer events.
useRightButton: if set to true it will listen to mouse right button down/up events instead of left button events(In WinRT it only applies if useManipulationEvents is set to false).

Remarks

Capturing the element on mouse down will cause Click, DoubleClick and MouseLeftButtonUp events not to be fired in sub-elements (nested elements in the visual tree), whereas capturing the element on the first mouse move can make it difficult for final users to drag small elements quickly.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

C1DragHelper Class
C1DragHelper Members