Click here to Skip to main content
15,891,033 members
Articles / Desktop Programming / Windows Forms
Tip/Trick

Draggable WinForms Controls

Rate me:
Please Sign up or sign in to vote.
4.98/5 (55 votes)
8 Apr 2011CPOL 94.1K   41   31
Extension method to make any WinForms control to be draggable at runtime

Sometimes, you need to make the control draggable during runtime. It can be a form with FormBorderStyle property set to None, or any other situation. I want to propose a simple extension method that allows you to make this possible.

C#
using System;
using System.Collections.Generic;
using System.Windows.Forms;
namespace DraggableControls
{
    public static class ControlExtension
    {
        // TKey is control to drag, TValue is a flag used while dragging
        private static Dictionary<Control, bool> draggables = 
                   new Dictionary<Control, bool>();
        private static System.Drawing.Size mouseOffset;
 
        /// <summary>
        /// Enabling/disabling dragging for control
        /// </summary>
        public static void Draggable(this Control control, bool Enable)
        {
            if (Enable)
            {
                // enable drag feature
                if (draggables.ContainsKey(control))
                {   // return if control is already draggable
                    return;
                }
                // 'false' - initial state is 'not dragging'
                draggables.Add(control, false);
 
                // assign required event handlersnnn
                control.MouseDown += new MouseEventHandler(control_MouseDown);
                control.MouseUp += new MouseEventHandler(control_MouseUp);
                control.MouseMove += new MouseEventHandler(control_MouseMove);
            }
            else
            {
                // disable drag feature
                if (!draggables.ContainsKey(control))
                {  // return if control is not draggable
                    return;
                }
                // remove event handlers
                control.MouseDown -= control_MouseDown;
                control.MouseUp -= control_MouseUp;
                control.MouseMove -= control_MouseMove;
                draggables.Remove(control);
            }
        }
        static void control_MouseDown(object sender, MouseEventArgs e)
        {
            mouseOffset = new System.Drawing.Size(e.Location);
            // turning on dragging
            draggables[(Control)sender] = true;
        }
        static void control_MouseUp(object sender, MouseEventArgs e)
        {
            // turning off dragging
            draggables[(Control)sender] = false;
        }
        static void control_MouseMove(object sender, MouseEventArgs e)
        {
            // only if dragging is turned on
            if (draggables[(Control)sender] == true)
            {
                // calculations of control's new position
                System.Drawing.Point newLocationOffset = e.Location - mouseOffset;
                ((Control)sender).Left += newLocationOffset.X;
                ((Control)sender).Top += newLocationOffset.Y;
            }
        }
    }
}

It's pretty simple to use this code. To make control draggable, you just need to write one line of code:

C#
AnyControl.Draggable(true);

and to disable this feature:

C#
AnyControl.Draggable(false);

For example, if your Form contains two checkboxes named checkBox_DragForm and checkBox_DragButton with CheckedChanged event handlers assigned, and button with name btnTest, you may use the following code to enable/disable drag feature on Form (represented by this) or/and button:

C#
private void checkBox_DragForm_CheckedChanged(object sender, EventArgs e)
{
    this.Draggable(checkBox_DragForm.Checked);
}
private void checkBox_DragButton_CheckedChanged(object sender, EventArgs e)
{
    btnTest.Draggable(checkBox_DragButton.Checked);
}

Update (2015-02-26): Extention is also available on Github and as a Nuget package

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer DevelopEx
Ukraine Ukraine
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
GeneralReason for my vote of 5 Nice and usefull snippet Pin
DotNetMastermind12-Apr-11 0:15
DotNetMastermind12-Apr-11 0:15 
GeneralReason for my vote of 5 Simple, like it. Pin
Kim Togo11-Apr-11 22:16
professionalKim Togo11-Apr-11 22:16 
GeneralReason for my vote of 5 Cool! Wish I needed to use this some... Pin
Ian Good11-Apr-11 13:54
Ian Good11-Apr-11 13:54 
GeneralMy vote 5 This was really nice. Pin
JAxelsson10-Apr-11 21:35
JAxelsson10-Apr-11 21:35 
GeneralReason for my vote of 5 Nice Pin
HiMik200310-Apr-11 20:57
HiMik200310-Apr-11 20:57 
GeneralReason for my vote of 5 Elegant and simple. Nice. Pin
Chris Trelawny-Ross8-Apr-11 7:32
Chris Trelawny-Ross8-Apr-11 7:32 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.