Class CustomDragProvider

Custom Drag Provider class will provide the option to change the default drag provider style.

Inheritance

System.Object

CustomDragProvider

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class CustomDragProvider : IDragProvider

Constructors

CustomDragProvider()

Creates a new instances of a class.

Declaration

public CustomDragProvider()

CustomDragProvider(DockingManager)

Overloaded constructor.

Declaration

public CustomDragProvider(DockingManager dockingManager)

Parameters

Type	Name	Description
DockingManager	dockingManager

Fields

bInitiateDrag

Indicates the flag to Initiate the drag or not

Declaration

protected bool bInitiateDrag

Field Value

Type	Description
System.Boolean

m_bAllowDrag

Declaration

protected bool m_bAllowDrag

Field Value

Type	Description
System.Boolean

m_borderWidth

Declaration

protected int m_borderWidth

Field Value

Type	Description
System.Int32

m_DockingManager

Declaration

protected DockingManager m_DockingManager

Field Value

Type	Description
DockingManager

m_singleTabOperate

Declaration

protected bool m_singleTabOperate

Field Value

Type	Description
System.Boolean

MessageFilter

Instance of the DragMessageFilter class to specify the messages of Mouse and Paint messages.

Declaration

protected static DragMessageFilter MessageFilter

Field Value

Type	Description
DragMessageFilter

ptDelta

Specifies the initial position of the dragging point.

Declaration

protected Point ptDelta

Field Value

Type	Description
System.Drawing.Point

ptMoveStart

Specifies the current point of the dragging window.

Declaration

protected Point ptMoveStart

Field Value

Type	Description
System.Drawing.Point

ShowDisallowFloatCursor

Static field to get or set the bool value whether the DisallowFloating cursor should be displayed or not.

Declaration

public static bool ShowDisallowFloatCursor

Field Value

Type	Description
System.Boolean

Properties

AllowDrag

Specifies whether dragging of controls is allowed.

Declaration

public bool AllowDrag { get; set; }

Property Value

Type	Description
System.Boolean

CanFloatWhenDisallowFloating

Returns the CanFloat When DisallowFloating

Declaration

public virtual bool CanFloatWhenDisallowFloating { get; }

Property Value

Type	Description
System.Boolean

DockingManager

Gets/sets the docking manager instance.

Declaration

public DockingManager DockingManager { get; set; }

Property Value

Type	Description
DockingManager

DraggingControl

Specifies the currently being dragged control.

Declaration

public IDraggable DraggingControl { get; set; }

Property Value

Type	Description
IDraggable

SingleTabOperate

Gets / Sets the SingleTabOperate.

Declaration

public virtual bool SingleTabOperate { get; set; }

Property Value

Type	Description
System.Boolean

Methods

CalculateFormOffset(IDraggable, Point)

Declaration

protected virtual Point CalculateFormOffset(IDraggable ctrl, Point ptClient)

Parameters

Type	Name	Description
IDraggable	ctrl
System.Drawing.Point	ptClient

Returns

Type	Description
System.Drawing.Point

CanFloat(DockControllerBase)

Declaration

protected bool CanFloat(DockControllerBase controller)

Parameters

Type	Name	Description
DockControllerBase	controller

Returns

Type	Description
System.Boolean

CanFloat(IDraggable)

Declaration

protected bool CanFloat(IDraggable draggingControl)

Parameters

Type	Name	Description
IDraggable	draggingControl

Returns

Type	Description
System.Boolean

CorrectDockedLocation(IDraggable)

Correct docked window location, after it has been dragged outside of working area, so it becomes visible.

Declaration

protected void CorrectDockedLocation(IDraggable ctrl)

Parameters

Type	Name	Description
IDraggable	ctrl

Dispose()

Dispose the custom drag provider.

Declaration

public virtual void Dispose()

ForceStopDrag()

Force the StopDrag

Declaration

public virtual void ForceStopDrag()

GetNewDockInfo(IDraggable, Point)

Overridable method. It gets current the Docking Information

Declaration

protected void GetNewDockInfo(IDraggable ctrl, Point ptscreen)

Parameters

Type	Name	Description
IDraggable	ctrl
System.Drawing.Point	ptscreen

GetUnderlayingController(Control)

Declaration

protected virtual DockHostController GetUnderlayingController(Control underlaying)

Parameters

Type	Name	Description
System.Windows.Forms.Control	underlaying

Returns

Type	Description
DockHostController

GetUnderlyingControl(Point)

Overridable method. Returns the control being dragged currently.

Declaration

public virtual Control GetUnderlyingControl(Point point)

Parameters

Type	Name	Description
System.Drawing.Point	point

Returns

Type	Description
System.Windows.Forms.Control

GetYOffset(out Int32, ref Point)

Declaration

protected void GetYOffset(out int borderHWidth, ref Point ptClient)

Parameters

Type	Name	Description
System.Int32	borderHWidth
System.Drawing.Point	ptClient

InitiateDrag(IDraggable, Point)

Overridable method.

Declaration

protected virtual void InitiateDrag(IDraggable ctrl, Point ptscreen)

Parameters

Type	Name	Description
IDraggable	ctrl
System.Drawing.Point	ptscreen

IsDockAllowed(IDraggable)

Returns if it is allowed do dock IDraggable control to internal target controller.

Declaration

protected virtual bool IsDockAllowed(IDraggable ctrl)

Parameters

Type	Name	Description
IDraggable	ctrl	Dragging control.

Returns

Type	Description
System.Boolean	Is dock operation allowed.

IsDockAllowed(IDraggable, DockControllerBase)

Returns if it is allowed do dock IDraggable control to specified target controller.

Declaration

protected virtual bool IsDockAllowed(IDraggable ctrl, DockControllerBase targetCtrl)

Parameters

Type	Name	Description
IDraggable	ctrl	Dragging control.
DockControllerBase	targetCtrl	Dock target control.

Returns

Type	Description
System.Boolean	Is dock operation allowed.

ProcessCtrlKeyDown()

Occurs on key down

Declaration

public virtual void ProcessCtrlKeyDown()

ProcessCtrlKeyUp()

Occurs the keyup event.

Declaration

public virtual void ProcessCtrlKeyUp()

ProcessDoubleClick()

Overridable method.

Declaration

public virtual void ProcessDoubleClick()

ProcessMouseDown(DockControllerBase, IDraggable, Point)

Overridable method.

Declaration

public virtual void ProcessMouseDown(DockControllerBase controller, IDraggable ctrl, Point ptscreen)

Parameters

Type	Name	Description
DockControllerBase	controller
IDraggable	ctrl
System.Drawing.Point	ptscreen

ProcessMouseMove(DockControllerBase, IDraggable, Point)

Overridable method.

Declaration

public virtual void ProcessMouseMove(DockControllerBase controller, IDraggable ctrl, Point ptscreen)

Parameters

Type	Name	Description
DockControllerBase	controller
IDraggable	ctrl
System.Drawing.Point	ptscreen

ProcessMouseUp(DockControllerBase, IDraggable, Point)

Overridable method.

Declaration

public virtual void ProcessMouseUp(DockControllerBase controller, IDraggable ctrl, Point ptscreen)

Parameters

Type	Name	Description
DockControllerBase	controller
IDraggable	ctrl
System.Drawing.Point	ptscreen

TerminateDrag(IDraggable, Point)

Overridable method.

Declaration

public virtual void TerminateDrag(IDraggable ctrl, Point ptscreen)

Parameters

Type	Name	Description
IDraggable	ctrl
System.Drawing.Point	ptscreen

TransitToPrevDock(IDraggable)

Declaration

protected virtual void TransitToPrevDock(IDraggable ctrl)

Parameters

Type	Name	Description
IDraggable	ctrl

UpdateColors()

Update colors.

Declaration

public virtual void UpdateColors()