Always dispose a form

beatles1692

Rate me:

4.43/5 (9 votes)

23 Nov 2009CPOL

15.8K

Some time ago, we noticed that in one of our projects the size of memory of our application is growing and it never decreased.After some checking and testing we realized that even if we have a local reference to a form, if we haven't disposed it explicitly it will remain on the stack and never

Some time ago, we noticed that in one of our projects the size of memory of our application is growing and it never decreased.

After some checking and testing we realized that even if we have a local reference to a form, if we haven't disposed it explicitly it will remain on the stack and never be collected.

So now, instead of writing this:

new usersDialog().ShowDialog()

We write:

using(var dlg=new usersDialog())
    dlg.ShowDialog();

License

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

Written By

beatles1692

Web Developer

Iran (Islamic Republic of)

This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

I'm pretty sure your conclusion (that not immediately deallocating your form was causing a memory leak) is incorrect. Perhaps you have another reference to your form or something like that that is causing it to stay around. Or maybe there is some funky event stuff you have hooked up that is keeping the references alive. The garbage collector should collect the form references just fine.

I just created a test application to see if I could reproduce the memory issue you were having, and I could not. Basically, the application showed the same form a hundred times in a row, with memory going up and down, not increasing. I created two forms... the main form with just one button on it. When that button is clicked, it initiates the logic to launch the second form 100 times in a row. The second form has several hundred controls on it (buttons/labels/textboxes), so it is consuming some memory. If you care to challenge my findings, here is the code for the first form:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Threading;

namespace DeleteMe_TestMemoryUsageFromForms
{
	// This form is in charge of showing the other form.
	public partial class Form1 : Form
	{
		public Form1()
		{
			InitializeComponent();
		}

		private void button1_Click(object sender, EventArgs e)
		{
			Thread t = new Thread(new ThreadStart(delegate()
			{
				// Show the other form 100 times.
				for (int i = 0; i < 100; i++)
				{
					this.Invoke(new ThreadStart(delegate()
					{
						(new TestForm()).ShowDialog();
					}));
				}
			}));
			t.Start();
		}
	}
}

Here is the code for the second form:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Threading;


namespace DeleteMe_TestMemoryUsageFromForms
{
	// This form has several hundred controls on it.
	public partial class TestForm : Form
	{
		Thread stopMe;

		public TestForm()
		{
			InitializeComponent();
			stopMe = new Thread(new ThreadStart(delegate()
			{
				// Wait 1/10th of a second, then close.
				System.Threading.Thread.Sleep(100);
				this.Invoke(new ThreadStart(delegate()
				{
					this.Close();
				}));
			}));
			stopMe.Start();
		}
	}
}

The first form just has a button on it and the second form has several hundred controls.

Visual Studio is an excellent GUIIDE.

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