Click here to Skip to main content
Click here to Skip to main content

How to copy files in C# with a customizable progress indicator and or progress bar

, 22 May 2009
Rate this:
Please Sign up or sign in to vote.
This article shows you how to construct a class to copy files and folder trees with an optional progress indicator.

Copy Files

Introduction

After reading about lots of ways to copy files with a progress indicator in C# and finding them all to be a little... long winded, I decided to write this article to help my fellow coders. It's a simple way to copy files and folders with a customizable progress bar/indicator.

Background

The class uses the Windows Kernal32 CopyFileEx function to do the copying of files. This being said, it does use one pointer, and so needs to be compiled with the /unsafe parameter (or simply tick the 'allow unsafe code' option in the project's properties)

You can create your own way to display the progress of the copy. To do this, simply implement the ICopyFileDiag interface and pass your class to the copy method.

//The interface for the Dialog the CopyFiles class uses.
public interface ICopyFilesDiag
{
    //needed to sync the CopyClass update events with the dialog thread
    System.ComponentModel.ISynchronizeInvoke SynchronizationObject { get; set; }

    //This event should fire when you want to cancel the copy
    event CopyFiles.DEL_cancelCopy EN_cancelCopy;

    //This is how the CopyClass will send your dialog information about
    //the transfer
    void update(Int32 totalFiles, Int32 copiedFiles, Int64 totalBytes, 
                Int64 copiedBytes, String currentFilename);
    void Show();
    void Hide();
}

Using the code

The guts of the code is in the CopyFiles class; however, once this is referenced in your application, it's simply a case of specifying a list of files for a directory to copy and the location to copy it to.

You then choose to do the copy asynchronously or synchronously:

private void But_CopyFiles_Click(object sender, EventArgs e)
{

    //This the list of random files we want 
    //to copy into a single new directory
    List<String> TempFiles = new List<String>();
    TempFiles.Add("C:\\Copy Test Folder\\test.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Bob.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test4\\Bob.Trev.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test4\\test.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test3\\Bob.Trev.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test3\\test.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test3\\B.o.b.Trev..txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test2\\Bob.Trev.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test2\\test.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test1\\test.txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test1\\B.o.b.Trev..txt");
    TempFiles.Add("C:\\Copy Test Folder\\Test1\\Bob.Trev.txt");

    //I would recommend you put at least one large file in this folder
    //to see the progress bar in action.
    CopyFiles.CopyFiles Temp = new CopyFiles.CopyFiles(TempFiles, "C:\\Test");
    
    //Uncomment the next line to copy the file tree.
    //CopyFiles.CopyFiles Temp = 
    // new CopyFiles.CopyFiles("C:\\Copy Test Folder", "C:\\Test");

    //Create the default Copy Files Dialog window from our Copy Files assembly
    //and sync it with our main/current thread
    CopyFiles.DIA_CopyFiles TempDiag = new CopyFiles.DIA_CopyFiles();
    TempDiag.SynchronizationObject = this;

    //Copy the files anysncrinsuly
    Temp.CopyAsync(TempDiag);

    //Uncomment this line to do a synchronous copy.
    ///Temp.Copy();

}

This is an example of how the ICopyFileDiag can be implemented:

public partial class DIA_CopyFiles : Form, ICopyFilesDiag
{
    // Properties
    public System.ComponentModel.ISynchronizeInvoke 
           SynchronizationObject { get; set; }
    // Constructors
    public DIA_CopyFiles()
    {
        InitializeComponent();
    }
    // Methods
    public void update(Int32 totalFiles, Int32 copiedFiles, 
           Int64 totalBytes, Int64 copiedBytes, String currentFilename)
    {
        Prog_TotalFiles.Maximum = totalFiles;
        Prog_TotalFiles.Value = copiedFiles;
        Prog_CurrentFile.Maximum = 100;
        if (totalBytes != 0)
        {
            Prog_CurrentFile.Value = Convert.ToInt32((100f / 
                  (totalBytes / 1024f)) * (copiedBytes / 1024f));
        }
        Lab_TotalFiles.Text = "Total files (" + copiedFiles + 
                  "/" + totalFiles + ")";
        Lab_CurrentFile.Text = currentFilename;
    }
    private void But_Cancel_Click(object sender, EventArgs e)
    {
        RaiseCancel();
    }
    private void DIA_CopyFiles_Closed(object sender, System.EventArgs e)
    {
        RaiseCancel();
    }
    private void RaiseCancel()
    {
        if (EN_cancelCopy != null)
        {
            EN_cancelCopy();
        }
    }
    //Events
    public event CopyFiles.DEL_cancelCopy EN_cancelCopy;
}

License

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

Share

About the Author

Neil Cadman

United Kingdom United Kingdom
No Biography provided

Comments and Discussions

 
QuestionCopy and Rename? PinmemberElSEEDY3-Jun-14 4:33 
QuestionUser Control copyComplete Event Pinmemberarbh8915-Nov-12 6:33 
QuestionUpdated Code Pinmemberjtitley3-Oct-11 18:50 
QuestionRe: Updated Code Pinmemberscooter_seh7-Apr-12 6:47 
AnswerRe: Updated Code Pinmemberzt08194913-Nov-12 16:40 
GeneralRe: Updated Code Pinmemberscooter_seh14-Nov-12 1:28 
GeneralRe: Updated Code Pinmemberzt08194914-Nov-12 2:52 
QuestionCopy also empty folders Pinmemberlozirion10-Feb-11 0:04 
AnswerRe: Copy also empty folders PinmemberGary Noter7-Jul-11 8:20 
Generalfolder structure Pinmemberpavelnt26-Nov-10 0:24 
GeneralMy vote of 5 PinmemberB.V.Papadopoulos6-Sep-10 1:06 
GeneralError Handling Pinmembermason.c2-Jun-10 10:45 
QuestionCopyfolder for me does not work with large files PinmemberNadeem Rasool15-Apr-10 5:15 
AnswerRe: Copyfolder for me does not work with large files PinmemberNeil Cadman4-May-10 9:49 
GeneralCool article! PinmemberAbhinav S27-Mar-10 21:01 
QuestionVery helpful but I would like to copy an entire tree of files and folder. Pinmemberkakaomocha26-Mar-10 9:05 
AnswerRe: Very helpful but I would like to copy an entire tree of files and folder. PinmemberNeil Cadman4-May-10 9:52 
GeneralRe: Very helpful but I would like to copy an entire tree of files and folder. PinmemberNeil Cadman4-May-10 10:02 
GeneralRe: Very helpful but I would like to copy an entire tree of files and folder. Pinmembernasermokkary17-May-10 23:40 
GeneralRe: Very helpful but I would like to copy an entire tree of files and folder. PinmemberGary Noter7-Jul-11 8:23 
GeneralVery helpful! Pinmemberkolluti11-Mar-10 6:20 
GeneralMy vote of 1 Pinmemberkurtkc9-Mar-10 16:15 
QuestionTrouble with events EV_copyCanceled and EV_copyComplete Pinmemberjpangamarca18-Dec-09 6:06 
AnswerRe: Trouble with events EV_copyCanceled and EV_copyComplete PinmemberNeil Cadman3-Jan-10 8:48 
GeneralRe: Trouble with events EV_copyCanceled and EV_copyComplete PinmemberDouglas Kirk20-Feb-10 7:33 

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.140821.2 | Last Updated 22 May 2009
Article Copyright 2009 by Neil Cadman
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid