Export (0) Print
Expand All

InPlaceHostingManager Class

Install a ClickOnce deployment on a machine.

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

public class InPlaceHostingManager : IDisposable
public class InPlaceHostingManager implements IDisposable
public class InPlaceHostingManager implements IDisposable
Not applicable.

You can use InPlaceHostingManager to write programs that install ClickOnce applications programmatically. For example, you can use this class in a controlled system management software (SMS) environment or in situations where you need a complex installation that performs a number of pre-installation or post-installation operations on the local computer. Generally, you will want to use the members of this class in a specific order:

  1. Create a new instance of InPlaceHostingManager.

  2. Download the deployment manifest by using GetManifestAsync.

  3. Check that the application can be run with the appropriate permissions by using AssertApplicationRequirements.

  4. Download and install the application by using DownloadApplicationAsync.

  • If you call any of these parameters out of order, they will throw an exception.

InPlaceHostingManager can install a ClickOnce application, but cannot execute it. Some methods in this class, such as Execute, are reserved for use when downloading a Windows Presentation Foundation-based application that runs inside a Web browser.

To use InPlaceHostingManager to download and install applications, you must make sure that the certificate for signing the ClickOnce applications you plan to install is already installed on client computers as a trusted publisher. For more information on trusted publishers, see Trusted Application Deployment Overview.

NoteNote:

There is currently a product limitation that prevents InPlaceHostingManager from working correctly when you debug your code using Visual Studio. If you debug your application in Visual Studio by using the F5 key, the sample will throw mysterious exceptions when you call DownloadApplicationAsync. To debug using Visual Studio, start the application without debugging, and then attach the debugger. Alternatively, you can use another debugger, such as WinDbg.

The following code example shows how to use InPlaceHostingManager to install a ClickOnce application programmatically on a client machine.

InPlaceHostingManager iphm = null;

private void InstallApplication(string deployManifestUriStr)
{
    try
    {
        Uri deploymentUri = new Uri(deployManifestUriStr);
        iphm = new InPlaceHostingManager(deploymentUri, false);
        MessageBox.Show("Created the object.");
    }
    catch (UriFormatException uriEx)
    {
        MessageBox.Show("Cannot install the application: The deployment manifest URL supplied is not a valid URL." +
            "Error: " + uriEx.Message);
        return;
    }
    catch (PlatformNotSupportedException platformEx)
    {
        MessageBox.Show("Cannot install the application: This program requires Windows XP or higher. " +
            "Error: " + platformEx.Message);
        return;
    }
    catch (ArgumentException argumentEx)
    {
        MessageBox.Show("Cannot install the application: The deployment manifest URL supplied is not a valid URL." +
            "Error: " + argumentEx.Message);
        return;
    }

    iphm.GetManifestCompleted += new EventHandler<GetManifestCompletedEventArgs>(iphm_GetManifestCompleted);
    iphm.GetManifestAsync();
}

void iphm_GetManifestCompleted(object sender, GetManifestCompletedEventArgs e)
{
    // Check for an error.
    if (e.Error != null)
    {
        // Cancel download and install.
        MessageBox.Show("Could not download manifest. Error: " + e.Error.Message);
        return;
    }

    // Dig inside of the manifest and see if this application requests full trust.
    // You can determine this by searching for a PermissionSet tag
    // that has the Unrestricted attribute set to true.
    bool isFullTrust = CheckForFullTrust(e.ApplicationManifest);

    // Verify this application can be installed.
    try
    {
        iphm.AssertApplicationRequirements();
    }
    catch (InvalidDeploymentException assertEx)
    {
        // Security exception. Report the error to the user.
        MessageBox.Show("Cannot install the application due to a security error. " +
            "Error text: " + assertEx.Message);
        return;
    }
    catch (Exception ex)
    {
        MessageBox.Show("An error occurred while verifying the application. " +
            "Error text: " + ex.Message);
        return;
    }

    // Use the information from GetManifestCompleted() to confirm 
    // that the user wants to proceed.
    string appInfo = "Application Name: " + e.ProductName;
    appInfo += "\nVersion: " + e.Version;
    appInfo += "\nSupport/Help Requests: " + (e.SupportUri != null ?
        e.SupportUri.ToString() : "N/A");
    appInfo += "\n\nConfirmed that this application can run with its requested permissions.";
    if (isFullTrust)
    {
        appInfo += "\n\nThis application requires full trust in order to run.";
    }
    appInfo += "\n\nProceed with installation?";

    DialogResult dr = MessageBox.Show(appInfo, "Confirm Application Install",
        MessageBoxButtons.OKCancel, MessageBoxIcon.Question);
    if (dr != System.Windows.Forms.DialogResult.OK)
    {
        return;
    }

    // Download the deployment manifest. 
    // We've added error handling here simply to be robust. Usually,
    // this shouldn't throw an exception unless 
    // AssertApplicationRequirements() failed, or you did not call that method
    // before calling this one.
    iphm.DownloadProgressChanged += new EventHandler<DownloadProgressChangedEventArgs>(iphm_DownloadProgressChanged);
    iphm.DownloadApplicationCompleted += new EventHandler<DownloadApplicationCompletedEventArgs>(iphm_DownloadApplicationCompleted);

    try
    {
        iphm.DownloadApplicationAsync();
    }
    catch (Exception downloadEx)
    {
        MessageBox.Show("Cannot initiate download of application. Error: " +
            downloadEx.Message);
        return;
    }
}

private bool CheckForFullTrust(XmlReader appManifest)
{
    bool isFullTrust = false;

    if (appManifest == null)
    {
        throw (new ArgumentNullException("appManifest cannot be null."));
    }

    while (appManifest.Read())
    {
        // Find the minimum required permission set.
        if (appManifest.NodeType == XmlNodeType.Element)
        {
            if (appManifest.Name.Equals("applicationRequestMinimum"))
            {
                // Get the next two nodes, which are PermissionSet and
                // defaultAssemblyRequest.
                // TODO: Will there ALWAYS be just one PermissionSet here? If so,
                // I can stick with the simple logic of just examining the 
                // PermissionSet node. Otherwise, I'll need to get 
                // defaultAssemblyRequest, and check the appropriate 
                // PermissionSet.   
                while (appManifest.Read())
                {
                    if (appManifest.Name.Equals("PermissionSet"))
                    {
                        // This is a required attribute - no need to sanity-check
                        // its existence.
                        if (appManifest.GetAttribute("Unrestricted").Equals("true"))
                        {
                            isFullTrust = true;
                        }

                        break;
                    }
                }

                break;
            }
        }
    }
    
    return isFullTrust;
}

void iphm_DownloadProgressChanged(object sender, DownloadProgressChangedEventArgs e)
{
    toolStripProgressBar1.ProgressBar.Value = e.ProgressPercentage;
}

void iphm_DownloadApplicationCompleted(object sender, DownloadApplicationCompletedEventArgs e)
{
    // Check for an error.
    if (e.Error != null)
    {
        // Cancel download and install.
        MessageBox.Show("Could not download and install application. Error: " + e.Error.Message);
        return;
    }

    // Inform the user that their application is ready for use. 
    MessageBox.Show("Application installed! You may now run it from the Start menu.");
}

System.Object
  System.Deployment.Application.InPlaceHostingManager

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

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft