Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles
(untagged)

Form Docker

0.00/5 (No votes)
23 Sep 2008 1  
Form Docker is a class library (DLL) that can dock any form to different parts of the screen.

Introduction

This class library can dock any form, on different parts of the screen. It acts just as the Dock property of a control acts, only with more options. Not only can this class library dock to the top, bottom, left, right, and fill, it can also dock to corners of the screen (top right, bottom left, etc.). It can also leave space around the edges of the screen, using the Padding property.

Background

While updating one of my projects, I found I was writing a lot of code for keeping the form in a certain place over and over again. I decided to write this class library to make it easier to keep forms in specific spots, and because I think it can be quite useful. If controls can be docked, why can't forms be docked?

Using the Library

The class library is provided as a DLL that can be referenced from your project. For those who don't know, you can add a reference by choosing "Add Reference..." from the "Project" menu and then selecting "Browse" to find the file.

Once referenced, you will need to create a new instance of the FormDocker class:

Dim Docker As New FormDocker.FormDocker(Me, _
           FormDocker.FormDocker.FormDockMode.Top, New Padding(5))

If you wish to take advantage of the events in the class, it can also be declared using WithEvents:

WithEvents Docker As New FormDocker.FormDocker(Me, _
           FormDocker.FormDocker.FormDockMode.Top, New Padding(5))

The first parameter represents the form to dock. The second is where to dock it, and the third is the padding. There are also optional parameters.

Once declared, the form will automatically be docked. The docking can be re-applied, that is the form re-positioned, any time, by using Refresh():

Docker.Refresh()

To undock the form, use UnDockForm(). To dock the form again, use DockForm(). These are equivalent to Dock = False and Dock = True.

'Undock form:
Docker.UnDockForm() 
'Or:
Docker.Dock = False

'Dock form:
Docker.DockForm()
'Or:
Docker.Dock = True

Feel free to explore other parts of the library, everything is commented. If you have any questions about how to use this library, please post a comment.

History

  • 23/09/08 - Version 1.0 released.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here