This documentation is archived and is not being maintained.

ApplicationDeployment.DownloadFileGroupCompleted Event

Note: This event is new in the .NET Framework version 2.0.

Occurs on the main application thread once a file download completes.

Namespace: System.Deployment.Application
Assembly: System.Deployment (in system.deployment.dll)

Public Event DownloadFileGroupCompleted As DownloadFileGroupCompletedEventHandler
Dim instance As ApplicationDeployment
Dim handler As DownloadFileGroupCompletedEventHandler

AddHandler instance.DownloadFileGroupCompleted, handler

/** @event */
public void add_DownloadFileGroupCompleted (DownloadFileGroupCompletedEventHandler value)

/** @event */
public void remove_DownloadFileGroupCompleted (DownloadFileGroupCompletedEventHandler value)

JScript supports the use of events, but not the declaration of new ones.

The DownloadFileGroupCompleted event is called on the main application thread. It is thread safe to call your application's Windows Forms controls directly within this callback.

Check the Error property of the AsyncCompletedEventArgs supplied to this callback. If this property is a null reference (Nothing in Visual Basic), the download was successful; if it is not a null reference (Nothing in Visual Basic), the installation did not succeed, and you can find more details on this through the Error property.

If you initiated the download with the DownloadFileGroupAsync method, you can use the UserState property to access any state information you passed in.

The following code example downloads a group of help files in the background. The example requires that you are deploying a Windows Forms application, and that this application contains a StatusStrip control, and it contains a ToolStripStatusPanelcontrol name downloadStatus.

Dim WithEvents ADDownloadHelpFiles As ApplicationDeployment

Private Sub DownloadHelpFiles(ByVal GroupName As String)
    If (ApplicationDeployment.IsNetworkDeployed) Then
        ADDownloadHelpFiles = ApplicationDeployment.CurrentDeployment

        If ADDownloadHelpFiles.IsFirstRun Then
                If ADDownloadHelpFiles.IsFileGroupDownloaded(GroupName) Then
                End If
            Catch ioe As InvalidOperationException
                MessageBox.Show("This application is not a ClickOnce application.")
            End Try
        End If
    End If
End Sub

Sub ADDownloadHelpFiles_DownloadFileGroupProgressChanged(ByVal sender As Object, ByVal e As DeploymentProgressChangedEventArgs) Handles ADDownloadHelpFiles.DownloadFileGroupProgressChanged
    DownloadStatus.Text = String.Format("Downloading file group {0}; {1:D}K of {2:D}K completed.", e.Group, e.BytesCompleted / 1024, e.BytesTotal / 1024)
End Sub

Sub ADDownloadHelpFiles_DownloadFileGroupCompleted(ByVal sender As Object, ByVal e As DownloadFileGroupCompletedEventArgs) Handles ADDownloadHelpFiles.DownloadFileGroupCompleted
    DownloadStatus.Text = String.Format("Download of file group {0} complete.", e.Group)
End Sub

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0