Walkthrough: Copying a Document to the End User Computer after a ClickOnce Installation

In the File menu, point to Add, and then click New Project.

In the Add New Project dialog box, in the Installed Templates pane, click Windows.

In the Templates pane, click Class Library.

In the Name field, type FileCopyPDA, and then click OK.

In Solution Explorer, click FileCopyPDA.

On the Project menu, click Add Reference.

In the Add Reference dialog box, in the .NET tab, add the following references:

• If your Excel project targets the .NET Framework 3.5, add references to Microsoft.VisualStudio.Tools.Applications.Runtime.v10.0 and Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.

• If your Excel project targets the .NET Framework 4, add references to Microsoft.VisualStudio.Tools.Applications.Runtime and Microsoft.VisualStudio.Tools.Applications.ServerDocument.

In the Class1 code file, add the following using or Imports statements to the top of the code file.

using Microsoft.VisualStudio.Tools.Applications.Deployment;
using Microsoft.VisualStudio.Tools.Applications;
using System.IO;

Rename the class to FileCopyPDA, and then add the following code to the FileCopyPDA class. This code indicates that FileCopyPDA class inherits from IAddInPostDeploymentAction.

public class FileCopyPDA : IAddInPostDeploymentAction

Add the following code to implement the IAddInPostDeploymentAction.Execute method. This code performs the following tasks:

• Copies the Excel workbook file to the user's desktop if the solution is installed or updated.

• Changes the _AssemblyLocation property from a relative path to a fully qualified path for the deployment manifest. This is done using the AddCustomization and RemoveCustomization methods.

• Deletes the file if the solution is uninstalled.

  Note
  The post-deployment action is run during the uninstall step for .NET Framework 3.5.

public void Execute(AddInPostDeploymentActionArgs args) 
{
    string dataDirectory = @"Data\ExcelWorkbook.xlsx";
    string file = @"ExcelWorkbook.xlsx";
    string sourcePath = args.AddInPath;
    Uri deploymentManifestUri = args.ManifestLocation;
    string destPath = Environment.GetFolderPath(Environment.SpecialFolder.DesktopDirectory);
    string sourceFile = System.IO.Path.Combine(sourcePath, dataDirectory);
    string destFile = System.IO.Path.Combine(destPath, file);

    switch (args.InstallationStatus)
    {
        case AddInInstallationStatus.InitialInstall:
        case AddInInstallationStatus.Update:
            File.Copy(sourceFile, destFile);
            ServerDocument.RemoveCustomization(destFile);
            ServerDocument.AddCustomization(destFile, deploymentManifestUri);
            break;
        case AddInInstallationStatus.Uninstall:
            if (File.Exists(destFile))
            {
                File.Delete(destFile);
            }
            break;
    }
}

In Solution Explorer, right-click the FileCopyPDA project, and then click Build.

In Solution Explorer, right-click the ExcelWorkbook project, and then click Build.

In Solution Explorer, right-click the ExcelWorkbook project, and then click Add Reference.

In the Add Reference dialog box, click the Projects tab.

Click FileCopyPDA, and click OK.

In Solution Explorer, click the ExcelWorkbook project.

On the Project menu, click New Folder.

Type Data and press the Enter key.

In Solution Explorer, click the Data folder.

On the Project menu, click Add Existing Item.

In the Add Existing Item dialog box, browse to the output directory for the ExcelWorkbook project.

Click ExcelWorkbook.xlsx, and click Add.

In Solution Explorer, click ExcelWorkbook.xlsx.

Note
If you modify this file later, make sure to update the file by adding the latest version of the file.

In the Properties window, change the Build Action property to Content, and the Copy to Output Directory property to Copy if newer.

Publish the ExcelWorkbook project to the c:\publish folder. For more information, see How to: Publish an Office Solution by Using ClickOnce.

Open the c:\publish directory through Windows Explorer.

Open the Application Files folder and then open the ExcelWorkbook_1_0_0_0 folder.

Open the ExcelWorkbook.dll.manifest file in a text editor.

Add following code after the </vstav3:update> element. For the class attribute of the <vstav3:entryPoint> element, use the following syntax: NamespaceName.ClassName. In this example, the namespace and class names are the same, so that the resulting entry point name is FileCopyPDA.FileCopyPDA.

<vstav3:postActions>
  <vstav3:postAction>
    <vstav3:entryPoint
      class="FileCopyPDA.FileCopyPDA">
      <assemblyIdentity
        name="FileCopyPDA"
        version="1.0.0.0"
        language="neutral"
        processorArchitecture="msil" />
    </vstav3:entryPoint>
    <vstav3:postActionData>
    </vstav3:postActionData>
  </vstav3:postAction>
</vstav3:postActions>

Copy the ExcelWorkbook_TemporaryKey.pfx certificate file from the %USERPROFILE%\Documents\Visual Studio 2010\Projects\ExcelWorkbook\ExcelWorkbook solution directory into the c:\publish\Application Files\ExcelWorkbook_1_0_0_0 directory.

Open the Visual Studio command prompt.

Change to the c:\publish\Application Files\ExcelWorkbook_1_0_0_0 directory.

Sign the modified application manifest with the following command:

mage -sign ExcelWorkbook.dll.manifest -certfile ExcelWorkbook_TemporaryKey.pfx

The message "ExcelWorkbook.dll.manifest successfully signed" appears.

Change to the c:\publish directory.

Update and sign the deployment manifest with the following command:

mage -update ExcelWorkbook.vsto -appmanifest "Application Files\Ex
celWorkbook_1_0_0_0\ExcelWorkbook.dll.manifest" -certfile "Application Files\ExcelWorkbook_1_0_0_0\ExcelWorkbook_TemporaryKey.pfx"

The message "ExcelWorkbook.vsto successfully signed" appears.

Copy the ExcelWorkbook.vsto file to the c:\publish\Application Files\ExcelWorkbook_1_0_0_0 directory.

Copy the c:\publish directory to a test computer.

Run the Setup.exe program, or if the prerequisites are already installed on the test computer, double-click the ExcelWorkbook.vsto deployment manifest.

The Microsoft Office Customization Installer appears.

Click Install.

The Microsoft Office Customization Installer dialog box shows the following message: "The Microsoft Office customization was successfully installed." The Excel workbook is copied to the end user's desktop.

Open the ExcelWorkbook.xlsx file from the desktop.