Displaying progress while transferring data

When the file to transfer is big and your application may take time to transfer, you may wish to show the progress of the transfer to the user. The UltimateZip component provides progress notification through the Progress event. The Progress event is raised periodically while data transfer is in progress, making accessible necessary data to display progress information, such as the size of the file and the number of bytes transferred.

The following steps show you how to use the Progress event to show progress information while transferring a file:

using System;
using ComponentPro.IO;
using ComponentPro.Compression;

...

private Zip _zip;
public void DoUpload()
{
    // Create a new instance. 
    Zip zip = new Zip();
    _zip = zip;

    // Create a new archive. 
    zip.Create("test.zip");

    // ... 
 
    zip.TransferConfirm += zip_TransferConfirm;
    zip.Progress += zip_Progress;

    try 
    {
        TransferOptions opt = new TransferOptions("*.*", FileOverwriteMode.Confirm);

        // Add all directories, subdirectories, and files in local folder 'c:\myfolder' to remote folder '/myfolder'. 
        zip.AddFiles("c:\\myfolder", "/myfolder", opt);
    }
    catch (Exception exc)
    {
        Console.WriteLine("Error: " + exc.Message);
    }

    // ... 
 
    // Close. 
    zip.Close();
}

/// <summary> 
/// This method is raised when user clicks on 'Cancel' button on the form. 
/// </summary> 
protected void btnCancel_Click(object sender, EventArgs e)
{
    // Cancel the upload operation when user clicks on the button. 
    _zip.Cancel();
}

void zip_Progress(object sender, ComponentPro.IO.FileSystemProgressEventArgs e)
{
    // Show progress info. 
    Console.WriteLine("Current File: %{0} completed", e.Percentage);
    Console.WriteLine("Total: %{0} completed", e.TotalPercentage);

    switch (e.State)
    {
        case TransferState.StartStoringFile:
            if (e.SourcePath.EndsWith(".exe"))
            {
                // Skip all .exe files 
                e.Skip = true;
            }
            else if (e.SourcePath.StartsWith(@"C:\MyFolder"))
            {
                // Change the source file path if it starts with "C:\MyFolder" 
                e.SourcePath = e.SourcePath.Replace(@"C:\MyFolder", @"C:\MySecondFolder");
            }
            break;
    }
}

void zip_TransferConfirm(object sender, ComponentPro.IO.TransferConfirmEventArgs e)
{
    if (e.Exception != null)
        Console.WriteLine("Error: " + e.Exception.Message);

    if (e.ConfirmReason == TransferConfirmReason.FileAlreadyExists)
    {
        // Skip the existing file. 
        e.NextAction = TransferConfirmNextActions.Skip;
    }

    Console.Write("Do you want to (r)etry or (s)kip?");
    string key = Console.ReadLine();
    if (key == "r")
        e.NextAction = TransferConfirmNextActions.Retry;
    else if (key == "s")
        e.NextAction = TransferConfirmNextActions.Skip;
    else 
        // Cancel the operation. 
        e.NextAction = TransferConfirmNextActions.Cancel;
}

Imports ComponentPro.IO
Imports ComponentPro.Compression

...

Private _zip As Zip
Public Sub DoUpload()
    ' Create a new instance. 
    Dim zip As New Zip()
    _zip = zip

    ' Create a new archive. 
    zip.Create("test.zip")

    ' ... 
 
    AddHandler zip.TransferConfirm, AddressOf zip_TransferConfirm
    AddHandler zip.Progress, AddressOf zip_Progress

    Try 
        Dim opt As New TransferOptions("*.*", FileOverwriteMode.Confirm)

        ' Add all directories, subdirectories, and files in local folder 'c:\myfolder' to remote folder '/myfolder'. 
        zip.AddFiles("c:\myfolder", "/myfolder", opt)
    Catch exc As Exception
        Console.WriteLine("Error: " & exc.Message)
    End Try 
 
    ' ... 
 
    ' Close. 
    zip.Close()
End Sub 
 
''' <summary> 
''' This method is raised when user clicks on 'Cancel' button on the form. 
''' </summary> 
Protected Sub btnCancel_Click(ByVal sender As Object, ByVal e As EventArgs)
    ' Cancel the upload operation when user clicks on the button. 
    _zip.Cancel()
End Sub 
 
Private Sub zip_Progress(ByVal sender As Object, ByVal e As ComponentPro.IO.FileSystemProgressEventArgs)
    ' Show progress info. 
    Console.WriteLine("Current File: %{0} completed", e.Percentage)
    Console.WriteLine("Total: %{0} completed", e.TotalPercentage)

    Select Case e.State
        Case TransferState.StartStoringFile
            If e.SourcePath.EndsWith(".exe") Then 
                ' Skip all .exe files 
                e.Skip = True 
            ElseIf e.SourcePath.StartsWith("C:\MyFolder") Then 
                ' Change the source file path if it starts with "C:\MyFolder" 
                e.SourcePath = e.SourcePath.Replace("C:\MyFolder", "C:\MySecondFolder")
            End If 
    End Select 
End Sub 
 
Private Sub zip_TransferConfirm(ByVal sender As Object, ByVal e As ComponentPro.IO.TransferConfirmEventArgs)
    If e.Exception IsNot Nothing Then 
        Console.WriteLine("Error: " & e.Exception.Message)
    End If 
 
    If e.ConfirmReason = TransferConfirmReason.FileAlreadyExists Then 
        ' Skip the existing file. 
        e.NextAction = TransferConfirmNextActions.Skip
    End If 
 
    Console.Write("Do you want to (r)etry or (s)kip?")
    Dim key As String = Console.ReadLine()
    If key = "r" Then 
        e.NextAction = TransferConfirmNextActions.Retry
    ElseIf key = "s" Then 
        e.NextAction = TransferConfirmNextActions.Skip
    Else 
        ' Cancel the operation. 
        e.NextAction = TransferConfirmNextActions.Cancel
    End If 
End Sub