Edit

Share via

Troubleshoot Office solution deployment

  • Article

Applies to: Visual Studio

This article introduces how to solve common problems that you might encounter when you deploy Office solutions.

The information in this article applies to document-level projects and Visual Studio Tools for Office (VSTO) Add-in projects. See Features available by Office application and project type.

Troubleshoot Office solutions by using the event viewer

You can use the event viewer in Windows to see error messages that are captured by the Visual Studio Tools for Office runtime when you install or uninstall Office solutions. You can use these messages from the event logger to resolve installation and deployment problems. For more information, see Event logging for Office solutions.

Change the assembly name causes conflicts

If you change the Assembly Name value in the Application page of the Project Designer after you've already deployed a solution, the publishing tools will modify the Setup package to have one Setup.exe file and two deployment manifests. If you deploy two manifest files, the following conditions might occur:

  • If the end user installs both versions, the application will load both VSTO Add-ins.
  • If the VSTO Add-in was installed before the assembly name was changed, the end user will never receive updates.

To avoid these conditions, don't change the solution's Assembly Name value after you deploy the solution.

Check for updates takes a long time

Visual Studio 2010 Tools for Office runtime provides a registry entry that administrators can use to set the time-out value for downloading the manifests and the solution.

How to set the time-out value

  1. In the registry, navigate to the following key:

    HKEY_CURRENT_USER\Software\Microsoft\VSTA

  2. In the AddInTimeout subkey, set the time-out value in milliseconds.

    If the AddInTimeout subkey doesn't exist, create it as a DWORD.

Can't update or publish to a network file share

Office solutions that are on a network file share might display a misleading message during updates if the solution's Setup.exe file is locked in a process while the update is being published. The message might say the following: "Unable to add 'setup.exe' to the Web. The file 'setup.exe' already exists in this Web."

To help prevent file locking, you can make the share read-only to the end users. However, if documents are on the share, they'll also become read-only to the end users.

Prerequisites for Microsoft Office aren't installed

You can add the .NET Framework, the Visual Studio Tools for Office runtime, and the Office primary interop assemblies to your Setup package as prerequisites that are deployed with your Office solution. For information about how to install the primary interop assemblies, see Configure a computer to develop Office solutions and How to: Install Office primary interop assemblies.

Publish using Localhost can cause installation problems

When you use http://localhost as the publish or installation location for document-level solutions, the Publish Wizard doesn't convert the string to the real computer name. In this case, the solution must be installed on the development computer. To make deployed solutions use IIS on the development computer, use the fully qualified name for all HTTP/HTTPS/FTP locations instead of localhost.

Cached assemblies are loaded instead of updated assemblies

Fusion, the .NET Framework assembly loader, loads the cached copy of assemblies when the project output path is on a network file share, the assembly is signed with a strong name, and the assembly version of the customization doesn't change. If you update an assembly that meets these conditions, the update won't appear the next time that you run the project because the cached copy is loaded.

You can configure Visual Studio so that Fusion will download assemblies every time that the project is run.

How to download assemblies instead of loading cached copies

  1. On the menu bar, select Project, <ProjectName> Properties.
  2. On the Application page, select Assembly Information.
  3. Set the revision number, third field, of the Assembly Version, to a wild card (*). For example, "1.0.*". Then select the OK button.

After you change the assembly version, you can continue to sign your assembly with a strong name, and Fusion will load the most recent version of the customization.

Note

Starting with Visual Studio 2017, if you try using wild cards in the Assembly Version a build error will occur. This is because wild cards in the assembly version will break the MSBuild Deterministic feature. You will be instructed to either remove the wildcards from the assembly version, or disable determinism. To learn more about the Deterministic feature see: Common MSBuild project properties and Customize your build

Installation fails when the URI has characters that aren't US-ASCII

When you publish an Office solution to an HTTP/HTTPS/FTP location, the path can't have any Unicode characters that aren't in US-ASCII. Such characters can cause inconsistent behavior in the Setup program. Use US-ASCII characters for the installation path.

Prompt to manually uninstall appears when you publish and install a solution on the development computer

When you build an Office solution, the built version is automatically registered. If you've previously published and installed the same solution to your development computer, Visual Studio Tools for Office runtime detects that the installation path for the published version and the built version are different after the solution is next built, rebuilt, or published. The error message says "the customization cannot be installed because another version is currently installed and cannot be upgraded from this location." The registry keys are updated whenever a solution is rebuilt. Therefore, you must uninstall the previous version before you publish, debug, or run the new version.

To prevent the message from appearing, create another user account on your development computer to test your deployment. As an alternative, you can uninstall the version from the list of installed programs on the computer before you next publish, debug, or rebuild the solution.

Uncaught exception or method not found error when you install a solution

When you install Office solutions by opening the deployment manifest (a .vsto file), Office application, document, or workbook, error messages for the following conditions might appear:

  • Method not found.
  • MissingMethodException.
  • Uncaught exception.

To prevent these error messages, install the solution by running the Setup program.

When you install the solution without running the Setup program, the installer doesn't check for or install prerequisites. The Setup program checks for the correct version of prerequisites and installs them as necessary.

Manifest registry keys for Add-ins change after an InstallShield Limited Edition project is built

The manifest registry key that's part of a VSTO Add-in Setup program sometimes changes from .vsto to .dll.manifest when you build an InstallShield Limited Edition project.

To work around this issue, create the InstallShield Limited Edition project in a different solution, or use CompanyName.AddinName as the value of the registry key that contains the name of the VSTO Add-in.

The ClickOnce Installer for your Office solution doesn't install the primary interop assemblies

When you run the Setup program that ClickOnce creates for your Office solution, the installer for the Office primary interop assemblies (PIAs) runs only if no PIAs are already installed.

If the Setup program doesn't install the PIAs correctly, install them manually by running the installer file that's named o2007pia.msi from the installation directory.

Reinstall Office solutions causes an argument out of range exception

When you reinstall an Office solution, a ArgumentOutOfRangeException exception might appear with the following error message: Specified argument was out of the range of valid values.

This situation occurs if the casing for the URL for the installation location is different. For example, this error would appear if you installed an Office solution from http://fabrikam.com/ExcelSolution.vsto the first time and then used http://fabrikam.com/excelsolution.vsto the second time.

To prevent the message from appearing, use the same casing when you install Office solutions.

Can't install a ClickOnce solution by opening the deployment manifest from the web

Users can install Office solutions by opening the deployment manifest from the web. However, some installations of Internet Information Services (IIS) block the .vsto file name extension. You must define the MIME type in IIS before you use it to deploy an Office solution.

For information about how to define the MIME type in IIS 7, see Add a MIME Type (IIS7).

Set the extension to .vsto and the MIME type to application/x-ms-vsto.

References