ApplicationDeployment Class

ApplicationDeployment Class

 

Supports updates of the current deployment programmatically, and handles on-demand downloading of files. This class cannot be inherited.

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

System.Object
  System.Deployment.Application.ApplicationDeployment

public sealed class ApplicationDeployment

NameDescription
System_CAPS_pubpropertyActivationUri

Gets the URL used to launch the deployment manifest of the application.

System_CAPS_pubpropertySystem_CAPS_staticCurrentDeployment

Returns the current ApplicationDeployment for this deployment.

System_CAPS_pubpropertyCurrentVersion

Gets the version of the deployment for the current running instance of the application.

System_CAPS_pubpropertyDataDirectory

Gets the path to the ClickOnce data directory.

System_CAPS_pubpropertyIsFirstRun

Gets a value indicating whether this is the first time this application has run on the client computer.

System_CAPS_pubpropertySystem_CAPS_staticIsNetworkDeployed

Gets a value indicating whether the current application is a ClickOnce application.

System_CAPS_pubpropertyTimeOfLastUpdateCheck

Gets the date and the time ClickOnce last checked for an application update.

System_CAPS_pubpropertyUpdatedApplicationFullName

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the full name of the application after it has been updated.

System_CAPS_pubpropertyUpdatedVersion

Gets the version of the update that was recently downloaded.

System_CAPS_pubpropertyUpdateLocation

Gets the Web site or file share from which this application updates itself.

NameDescription
System_CAPS_pubmethodCheckForDetailedUpdate()

Performs the same operation as CheckForUpdate, but returns extended information about the available update.

System_CAPS_pubmethodCheckForDetailedUpdate(Boolean)

Performs the same operation as CheckForUpdate, but returns extended information about the available update.

System_CAPS_pubmethodCheckForUpdate()

Checks UpdateLocation to determine whether a new update is available.

System_CAPS_pubmethodCheckForUpdate(Boolean)

Checks UpdateLocation to determine whether a new update is available.

System_CAPS_pubmethodCheckForUpdateAsync()

Checks UpdateLocation asynchronously to determine whether a new update is available.

System_CAPS_pubmethodCheckForUpdateAsyncCancel()

Cancels the asynchronous update check.

System_CAPS_pubmethodDownloadFileGroup(String)

Downloads a set of optional files on demand.

System_CAPS_pubmethodDownloadFileGroupAsync(String)

Downloads, on demand, a set of optional files in the background.

System_CAPS_pubmethodDownloadFileGroupAsync(String, Object)

Downloads, on demand, a set of optional files in the background, and passes a piece of application state to the event callbacks.

System_CAPS_pubmethodDownloadFileGroupAsyncCancel(String)

Cancels an asynchronous file download.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsFileGroupDownloaded(String)

Checks whether the named file group has already been downloaded to the client computer.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodUpdate()

Starts a synchronous download and installation of the latest version of this application.

System_CAPS_pubmethodUpdateAsync()

Starts an asynchronous download and installation of the latest version of this application.

System_CAPS_pubmethodUpdateAsyncCancel()

Cancels an asynchronous update initiated by UpdateAsync.

NameDescription
System_CAPS_pubeventCheckForUpdateCompleted

Occurs when CheckForUpdateAsync has completed.

System_CAPS_pubeventCheckForUpdateProgressChanged

Occurs when a progress update is available on a CheckForUpdateAsync call.

System_CAPS_pubeventDownloadFileGroupCompleted

Occurs on the main application thread when a file download is complete.

System_CAPS_pubeventDownloadFileGroupProgressChanged

Occurs when status information is available on a file download operation initiated by a call to DownloadFileGroupAsync.

System_CAPS_pubeventUpdateCompleted

Occurs when ClickOnce has finished upgrading the application as the result of a call to UpdateAsync.

System_CAPS_pubeventUpdateProgressChanged

Occurs when ClickOnce has new status information for an update operation initiated by calling the UpdateAsync method.

You can configure your ClickOnce application to check for updates and install them automatically through the subscription element of the deployment manifest. Some applications, however, need finer control over their updates. You may want to install required updates programmatically, and prompt users to install optional updates at their convenience. By turning off subscription updates in the deployment manifest, you can take complete control of your application's update policies. Alternatively, you can use automatic subscription in conjunction with ApplicationDeployment, which enables ClickOnce to update the application periodically, but uses ApplicationDeployment to download critical updates shortly after they are released.

You can test whether your deployment has an available update by using either the CheckForUpdate or the CheckForUpdateAsync method; the latter method raises the CheckForUpdateCompleted event on successful completion. CheckForDetailedUpdate returns important information about the update, such as its version number and whether it is a required update for current users. If an update is available, you can install it by using Update or UpdateAsync; the latter method raises the UpdateCompleted event after installation of the update is complete. For large updates, you can receive progress notifications through the CheckForUpdateProgressChanged and UpdateProgressChanged events, and use the information in ProgressChangedEventArgs to notify the user of the download status.

You can also use ApplicationDeployment to download large files and assemblies on demand. These files must be marked as "optional" within the deployment's application manifest so that they are not downloaded during installation. You can download the files at any point during the application's duration by using the DownloadFileGroup or the DownloadFileGroupAsync method. You can download assemblies before they are loaded into memory by supplying an event handler for the AssemblyResolve event on the AppDomain class. For more information, see Walkthrough: Downloading Assemblies on Demand with the ClickOnce Deployment API Using the Designer.

System_CAPS_noteNote

If you update a ClickOnce application while the application is running, the user will not see the updates until you call the Restart method of the Application, which will close the current running instance of the application and immediately restart it.

ApplicationDeployment has no public constructor; you obtain instances of the class within a ClickOnce application through the CurrentDeployment property. You use the IsNetworkDeployed property to verify that the current application is a ClickOnce application.

ApplicationDeployment supports checking for updates and downloading updated files asynchronously by using the new Event-based Asynchronous Pattern Overview, which exposes completion callbacks as class events. ApplicationDeployment starts and manages the threads for you, and calls your application back on the correct UI thread. Through this class, you can update without locking up the application, so that the user can continue working while the update installs. If the user must stop all work while an update takes place, consider using the synchronous methods instead.

System_CAPS_noteNote

Performing asynchronous updates requires that your application import both the System.Deployment.Application and System.ComponentModel namespaces.

The following code example determines at application load time whether a new update is available; if a required update is available, the code example installs the update asynchronously. This code should be added to a form that contains a TextBox named downloadStatus.

long sizeOfUpdate = 0;

private void UpdateApplication()
{
    if (ApplicationDeployment.IsNetworkDeployed)
    {
        ApplicationDeployment ad = ApplicationDeployment.CurrentDeployment;
        ad.CheckForUpdateCompleted += new CheckForUpdateCompletedEventHandler(ad_CheckForUpdateCompleted);
        ad.CheckForUpdateProgressChanged += new DeploymentProgressChangedEventHandler(ad_CheckForUpdateProgressChanged);

        ad.CheckForUpdateAsync();
    }
}

void  ad_CheckForUpdateProgressChanged(object sender, DeploymentProgressChangedEventArgs e)
{
    downloadStatus.Text = String.Format("Downloading: {0}. {1:D}K of {2:D}K downloaded.", GetProgressString(e.State), e.BytesCompleted/1024, e.BytesTotal/1024);   
}

string GetProgressString(DeploymentProgressState state)
{
    if (state == DeploymentProgressState.DownloadingApplicationFiles)
    {
        return "application files";
    } 
    else if (state == DeploymentProgressState.DownloadingApplicationInformation) 
    {
        return "application manifest";
    } 
    else 
    {
        return "deployment manifest";
    }
}

void ad_CheckForUpdateCompleted(object sender, CheckForUpdateCompletedEventArgs e)
{
    if (e.Error != null)
    {
        MessageBox.Show("ERROR: Could not retrieve new version of the application. Reason: \n" + e.Error.Message + "\nPlease report this error to the system administrator.");
        return;
    }
    else if (e.Cancelled == true)
    {
        MessageBox.Show("The update was cancelled.");
    }

    // Ask the user if they would like to update the application now.
    if (e.UpdateAvailable)
    {
        sizeOfUpdate = e.UpdateSizeBytes;

        if (!e.IsUpdateRequired)
        {
            DialogResult dr = MessageBox.Show("An update is available. Would you like to update the application now?\n\nEstimated Download Time: ", "Update Available", MessageBoxButtons.OKCancel);
            if (DialogResult.OK == dr)
            {
                BeginUpdate();
            }
        }
        else
        {
            MessageBox.Show("A mandatory update is available for your application. We will install the update now, after which we will save all of your in-progress data and restart your application.");
            BeginUpdate();
        }
    }
}

private void BeginUpdate()
{
    ApplicationDeployment ad = ApplicationDeployment.CurrentDeployment;
    ad.UpdateCompleted += new AsyncCompletedEventHandler(ad_UpdateCompleted);

    // Indicate progress in the application's status bar.
    ad.UpdateProgressChanged += new DeploymentProgressChangedEventHandler(ad_UpdateProgressChanged);
    ad.UpdateAsync();
}

void ad_UpdateProgressChanged(object sender, DeploymentProgressChangedEventArgs e)
{
    String progressText = String.Format("{0:D}K out of {1:D}K downloaded - {2:D}% complete", e.BytesCompleted / 1024, e.BytesTotal / 1024, e.ProgressPercentage);
    downloadStatus.Text = progressText;
}

void ad_UpdateCompleted(object sender, AsyncCompletedEventArgs e)
{
    if (e.Cancelled)
    {
        MessageBox.Show("The update of the application's latest version was cancelled.");
        return;
    }
    else if (e.Error != null)
    {
        MessageBox.Show("ERROR: Could not install the latest version of the application. Reason: \n" + e.Error.Message + "\nPlease report this error to the system administrator.");
        return;
    }

    DialogResult dr = MessageBox.Show("The application has been updated. Restart? (If you do not restart now, the new version will not take effect until after you quit and launch the application again.)", "Restart Application", MessageBoxButtons.OKCancel);
    if (DialogResult.OK == dr)
    {
        Application.Restart();
    }
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft