New to Telerik UI for WinForms? Start a free 30-day trial

DragDropService

Class

Encapsulates the core drag-and-drop functionality for a RadDock instance. What RadDock does is to start and stop the service when drag operation is instanciated.

Definition

Namespace:Telerik.WinControls.UI.Docking

Assembly:Telerik.WinControls.RadDock.dll

Syntax:

public class DragDropService : StateService, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx, IMessageListener

Inheritance: objectRadDockObjectRadDockServiceStateServiceDragDropService

Implements: IDisposableIMessageListenerINotifyPropertyChangedINotifyPropertyChangingEx

Inherited Members StateService.Start(object)StateService.Stop(bool)StateService.Pause()StateService.Resume()StateService.OnEnabledChanged()StateService.OnStarted()StateService.OnStarting(StateServiceStartingEventArgs)StateService.OnStopped()StateService.Abort()StateService.PerformResume()StateService.PerformPause()StateService.SetContext(object)StateService.ContextStateService.StateStateService.StartingStateService.StartedStateService.StoppingStateService.StoppedRadDockService.CanOperate()RadDockService.DockManagerDesignModeRadDockService.DockManagerRadDockService.EnabledRadDockObject.Dispose()RadDockObject.Dispose(bool)RadDockObject.DisposeUnmanagedResources()RadDockObject.OnPropertyChanging(string)RadDockObject.OnPropertyChanged(string)RadDockObject.ShouldSerializeProperty(string)RadDockObject.EventsRadDockObject.DisposingRadDockObject.IsDisposedRadDockObject.DisposedRadDockObject.PropertyChangingRadDockObject.PropertyChanged...

Constructors

DragDropService()

Default constructor.

public DragDropService()

Fields

DocumentDragInvalid

Cursor

public static Cursor DocumentDragInvalid

DocumentDragValid

Cursor

public static Cursor DocumentDragValid

Properties

AllowedDockManagerEdges

AllowedDockPosition

Determines what of the owning RadDock instance's edges will be allowed for drop.

public AllowedDockPosition AllowedDockManagerEdges { get; set; }

AllowedStates

AllowedDockState

Gets or sets the allowed states for committing drag-and-drop operation.

public AllowedDockState AllowedStates { get; set; }

AvailableAtDesignTime

bool

Drag-and-drop service is available at design-time (in preview mode only).

public override bool AvailableAtDesignTime { get; }

Overrides: StateService.AvailableAtDesignTime

DragDropBehavior

Gets or sets the behavior of the service when it is running. Allows for specifying manual behavior, which enables service automation.

public DragDropBehavior DragDropBehavior { get; set; }

DragDropContext

Gets the DragDropContext value, which defines what is the current drag context.

public DragDropContext DragDropContext { get; }

DragDropMode

Gets or sets the mode used by the service to perform drag-and-drop operations.

public DragDropMode DragDropMode { get; set; }

DropAnchor

SplitPanel

Gets the target of the drop operation. This member is valid only while the service is started and may be null.

public SplitPanel DropAnchor { get; }

HitTestResult

DockingGuideHitTest

Gets the hit-test result of the current drag-drop operation. Valid only while the service is started.

public DockingGuideHitTest HitTestResult { get; }

ShowDockingGuides

bool

Gets or Sets the value which indicates whether the docking guides will be shown.

public bool ShowDockingGuides { get; set; }

Methods

CanStart(object)

Determines whether the service can start using the provided context.

protected override bool CanStart(object context)

Parameters:contextobjectReturns:

bool

Overrides: StateService.CanStart(object)

Commit()

Commits the drag-and-drop operation.

protected override void Commit()

Overrides: StateService.Commit()

DisposeManagedResources()

protected override void DisposeManagedResources()

Overrides: RadDockObject.DisposeManagedResources()

Drag(Point)

Preforms a drag pass, during which a hit-test operation is performed and docking guides and hints are updated respectively.

protected virtual void Drag(Point mousePos)

Parameters:mousePosPoint

GetDockingGuideAllowedPosition(DockingGuidesPosition)

Gets the allowed position for the currently displayed guide for the specified guide position.

public AllowedDockPosition GetDockingGuideAllowedPosition(DockingGuidesPosition guidePosition)

Parameters:guidePositionDockingGuidesPosition

The position of the guide.

Returns:

AllowedDockPosition

GetDockingGuideBounds(DockingGuidesPosition)

Gets the current screen bounds for the specified DockingGuide.

public Rectangle GetDockingGuideBounds(DockingGuidesPosition position)

Parameters:positionDockingGuidesPositionReturns:

Rectangle

GetDragLocation()

Gets the current location for a dragged object. The associated object depends on the current drag mode - it may be a FloatingWindow or a DockingHintPopup instance.

protected virtual Point GetDragLocation()

Returns:

Point

GetDropTarget()

Searches for a drop target under the cursor position. May return null if no appropriate control is found.

protected virtual SplitPanel GetDropTarget()

Returns:

SplitPanel

IsContextValid(object)

Determines whether the provides context is valid and a drag-drop operation may be instanciated.

protected override bool IsContextValid(object context)

Parameters:contextobjectReturns:

bool

Overrides: StateService.IsContextValid(object)

OnDockingGuidesTemplateChanged()

Receives notification for a change in the current docking guides template.

protected virtual void OnDockingGuidesTemplateChanged()

OnDockManagerChanged()

protected override void OnDockManagerChanged()

Overrides: StateService.OnDockManagerChanged()

OnDragging(CancelEventArgs)

Raises the Dragging notification.

protected virtual void OnDragging(CancelEventArgs args)

Parameters:argsCancelEventArgs

OnStopping(StateServiceStoppingEventArgs)

Notifies for a Stop request.

protected override void OnStopping(StateServiceStoppingEventArgs e)

Parameters:eStateServiceStoppingEventArgs

Overrides: StateService.OnStopping(StateServiceStoppingEventArgs)

PerformDrag(Point)

Performs a drag pass. Allows for service automation. The service must be started for this method to execute properly.

public void PerformDrag(Point screenMousePos)

Parameters:screenMousePosPoint

The position of the mouse in screen coordinates.

PerformStart()

Preforms the core start process.

protected override void PerformStart()

Overrides: StateService.PerformStart()

PerformStop()

Performs the core stop process.

protected override void PerformStop()

Overrides: StateService.PerformStop()

PositonDockingGuides()

Updates all docking guides' bounds on the screen.

protected virtual void PositonDockingGuides()

Start(object, Point)

Starts the service with the specified context, using the provided Point as initial.

public void Start(object context, Point start)

Parameters:contextobjectstartPoint

Events

Dragging

CancelEventHandler

Notifies for a Drag event of the service. While working, this notification will be raised upon each mouse move event.

public event CancelEventHandler Dragging

PreviewDockPosition

DragDropDockPositionEventHandler

Allows listeners to preview and optionally modify the allowed dock position for the hit-tested drop target.

public event DragDropDockPositionEventHandler PreviewDockPosition

PreviewDropTarget

DragDropTargetEventHandler

Allows listeners to preview and optionally change the currently hit-tested drop target.

public event DragDropTargetEventHandler PreviewDropTarget

PreviewHitTest

DragDropHitTestEventHandler

Allows listeners to preview and optionally change the current hit-test result generated by the service upon a drag operation.

public event DragDropHitTestEventHandler PreviewHitTest