Click here to Skip to main content
Click here to Skip to main content
Go to top

Progress Indicator - Customizable

, 31 May 2011
Rate this:
Please Sign up or sign in to vote.
This article demonstrates a customizable busy progress indicator for Windows Forms applications.

 

 

Introduction 

This article demonstrates creating a progress indicator control, usually used in displaying the progress in populating a large number of data.

Background

  • The key is to create active and inactive images, and to place them appropriately to make it appear animated.
  • A timer running in the background updates the position of the active image in a consistent duration.
  • Control is designed to be customizable in the designer, and can be shown as a modal dialog at runtime.
  • The images are usually of rectangular form and the background is ignored by a BitMap.MakeTransparent call.

Using the Code

The total number of images in the ProgressIndicator is controlled by the DotsCount property. A timer running on the background decides which index to be drawn active, and the rest of the indexes are painted inactive.

void _progressTimer_Tick(object sender, EventArgs e)
{
    this.ActiveIndex++;

    if (ActiveIndex == this.DotsCount)
        this.ActiveIndex = 0;

    this.Refresh();
}

And in the paint event, active and inactive images are drawn; each image will be placed at a distance calculated based on the width of the control and the images.

while (iterator < this.DotsCount)
{
    if (iterator == this.ActiveIndex)
    {
        e.Graphics.DrawImageUnscaled(this.ActiveImage,new Point(X,Y));
    }
    else
    {
        e.Graphics.DrawImageUnscaled(this.InActiveImage,new Point(X,Y));
    }
}

Default active and inactive images are added to the assembly as embedded resources, and populated to the property when the control is instantiated, as follows:

Stream imgStream = Assembly.GetExecutingAssembly().GetManifestResourceStream(
                   "Creatives.Resources.ActiveImage.png");
this._activeDot = Image.FromStream(imgStream);
(this._activeDot as Bitmap).MakeTransparent(Color.White);
            
imgStream = Assembly.GetExecutingAssembly().GetManifestResourceStream(
                     "Creatives.Resources.InActiveImage.png");
this._inactiveDot = Image.FromStream(imgStream);
(this._inactiveDot as Bitmap).MakeTransparent(Color.White);

When the Show method is invoked, the control is added to the WrapperForm and filled to its size and shown as a dialog window.

public void ShowProgressIndicator()
{
    this.WrapperForm.Controls.Add(this);
    this.WrapperForm.Size = this.Size;
    this.Dock = DockStyle.Fill;

    this.WrapperForm.ShowDialog();
}

Points of Interest

Every event hooked must be unhooked to avoid the object being held in memory to avoid memory leaks, and any unmanaged resources being used must be released.

protected override void Dispose(bool disposing)
{
    if (disposing)
    {
        _progressTimer.Tick -= new EventHandler(_progressTimer_Tick);

        if (_wrapperForm != null)
        {
            _wrapperForm.Shown -= new EventHandler(wrapperFormShown);
        }
    }

    base.Dispose(disposing);
}

The wrapper form will not receive mouse activation, and remains on top of all the other windows; this is done with the help of window styles.

CreateParams cp = base.CreateParams;

cp.ExStyle |= /*WS_EX_TOPMOST */0x00000008 | /*WS_EX_NOACTIVATE */0x08000000;

// Take a look at this link for more window styles
// http://www.pinvoke.net/default.aspx/Enums/WindowStylesEx.html

Hope this helps you in building a rich user interface. Please do leave your valuable comments and suggestions.

License

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

Share

About the Author

VallarasuS
Software Developer
India India
I code, learn, listen, and some day in a near future be a proud farmer.
Follow on   Twitter

Comments and Discussions

 
QuestionUnable to download the source or demo PinmemberMember 422724827-Nov-13 16:11 
AnswerRe: Unable to download the source or demo PinmemberVallarasuS28-Nov-13 7:32 
GeneralMy vote of 4 PinmemberYvan Rodrigues7-Jun-11 3:25 
GeneralMy vote of 5 PinmemberMonjurul Habib6-Jun-11 21:01 
GeneralShort article PinmemberSlacker00731-May-11 5:02 
GeneralRe: Short article Pinmembervallarasus1-Jun-11 7:13 

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

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

| Advertise | Privacy | Mobile
Web04 | 2.8.140916.1 | Last Updated 31 May 2011
Article Copyright 2011 by VallarasuS
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid