Class

DragDropService

Default constructor.

Declaration

public DragDropService()

Declaration

public static Cursor DocumentDragInvalid

Field Value

Declaration

public static Cursor DocumentDragValid

Field Value

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

Declaration

public AllowedDockPosition AllowedDockManagerEdges { get; set; }

Property Value

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

Declaration

public AllowedDockState AllowedStates { get; set; }

Property Value

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

Declaration

public override bool AvailableAtDesignTime { get; }

Property Value

Overrides StateService.AvailableAtDesignTime

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

Declaration

public DragDropBehavior DragDropBehavior { get; set; }

Property Value

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

Declaration

public DragDropContext DragDropContext { get; }

Property Value

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

Declaration

public DragDropMode DragDropMode { get; set; }

Property Value

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

Declaration

public SplitPanel DropAnchor { get; }

Property Value

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

Declaration

public DockingGuideHitTest HitTestResult { get; }

Property Value

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

Declaration

public bool ShowDockingGuides { get; set; }

Property Value

Determines whether the service can start using the provided context.

Declaration

protected override bool CanStart(object context)

Parameters

Returns

Overrides StateService.CanStart(object)

Commits the drag-and-drop operation.

Declaration

protected override void Commit()

Overrides StateService.Commit()

Declaration

protected override void DisposeManagedResources()

Overrides RadDockObject.DisposeManagedResources()

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

Declaration

protected virtual void Drag(Point mousePos)

Parameters

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

Declaration

public AllowedDockPosition GetDockingGuideAllowedPosition(DockingGuidesPosition guidePosition)

Parameters

Returns

Gets the current screen bounds for the specified DockingGuide.

Declaration

public Rectangle GetDockingGuideBounds(DockingGuidesPosition position)

Parameters

Returns

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.

Declaration

protected virtual Point GetDragLocation()

Returns

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

Declaration

protected virtual SplitPanel GetDropTarget()

Returns

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

Declaration

protected override bool IsContextValid(object context)

Parameters

Returns

Overrides StateService.IsContextValid(object)

Declaration

protected override void OnDockManagerChanged()

Overrides StateService.OnDockManagerChanged()

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

Declaration

protected virtual void OnDockingGuidesTemplateChanged()

Raises the Dragging notification.

Declaration

protected virtual void OnDragging(CancelEventArgs args)

Parameters

Notifies for a Stop request.

Declaration

protected override void OnStopping(StateServiceStoppingEventArgs e)

Parameters

Overrides StateService.OnStopping(StateServiceStoppingEventArgs)

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

Declaration

public void PerformDrag(Point screenMousePos)

Parameters

Preforms the core start process.

Declaration

protected override void PerformStart()

Overrides StateService.PerformStart()

Performs the core stop process.

Declaration

protected override void PerformStop()

Overrides StateService.PerformStop()

Updates all docking guides' bounds on the screen.

Declaration

protected virtual void PositonDockingGuides()

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

Declaration

public void Start(object context, Point start)

Parameters

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

Declaration

public event CancelEventHandler Dragging

Event Value

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

Declaration

public event DragDropDockPositionEventHandler PreviewDockPosition

Event Value

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

Declaration

public event DragDropTargetEventHandler PreviewDropTarget

Event Value

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

Declaration

public event DragDropHitTestEventHandler PreviewHitTest

Event Value