How to: Remove Managed Code Extensions from Documents

You can programmatically remove the customization assembly from a document or workbook that is part of a document-level customization for Microsoft Office Word or Microsoft Office Excel. Users can then open the documents and view the contents, but any custom user interface (UI) you add to the documents will not appear, and your code will not run.

Applies to: The information in this topic applies to document-level projects for the following applications: Excel 2007 and Excel 2010; Word 2007 and Word 2010. For more information, see Features Available by Office Application and Project Type.

You can remove the customization assembly by using one of the RemoveCustomization methods provided by the Visual Studio Tools for Office runtime. Which method you use depends on whether you want to remove the customization at run time (that is, by running code in the customization while the Word document or Excel workbook is open), or if you want to remove the customization from a closed document or a document that is on a server that does not have Microsoft Office installed.

For a related video demonstration, see How Do I: Attach or Detach a VSTO Assembly from a Word Document?.

To remove the customization assembly at run time

• In your customization code, call the Document.RemoveCustomization method (for Word) or the Workbook.RemoveCustomization method (for Excel). This method should be called only after the customization is no longer needed.

  Where you call this method in your code depends on how your customization is used. For example, if customers use your customization's features until they are ready to send the document to other clients that only need to the document itself (not the customization), you can provide some UI that calls RemoveCustomization when the customer clicks it. Alternatively, if your customization populates the document with data when it is first opened, but the customization doesn't provide any other features that are accessed directly by customers, then you can call RemoveCustomization as soon as your customization finishes initializing the document.

To remove the customization assembly from a closed document or a document on a server

1. In a project that does not require Microsoft Office, such as a console application or Windows Forms project, add a reference to one of the following assemblies:

   • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll (if the project targets the .NET Framework 4).

   • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll (if the project targets the .NET Framework 3.5).

2. Add the following Imports or using statement to the top of your code file.

   Imports Microsoft.VisualStudio.Tools.Applications
   

   using Microsoft.VisualStudio.Tools.Applications;
   

3. Call the static RemoveCustomization method of the ServerDocument class, and specify the solution document path for the parameter.

   The following code example assumes that you are removing the customization from a document named WordDocument1.docx that is on the desktop.

   Dim documentPath As String = System.Environment.GetFolderPath( _
       Environment.SpecialFolder.Desktop) & "\WordDocument1.docx"
   Dim runtimeVersion As Integer = 0
   
   Try
       runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
       If runtimeVersion = 3 Then
           ServerDocument.RemoveCustomization(documentPath)
           System.Windows.Forms.MessageBox.Show("The customization has been removed.")
       End If
   Catch ex As FileNotFoundException
       System.Windows.Forms.MessageBox.Show("The specified document does not exist.")
   Catch ex As IOException
       System.Windows.Forms.MessageBox.Show("The specified document is read-only.")
   Catch ex As InvalidOperationException
       System.Windows.Forms.MessageBox.Show("The customization could not be removed." & _
           vbLf & ex.Message)
   End Try
   

   string documentPath = System.Environment.GetFolderPath(
       Environment.SpecialFolder.Desktop) + @"\WordDocument1.docx";
   int runtimeVersion = 0;
   
   try
   {
       runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
   
       if (runtimeVersion == 3)
       {
           ServerDocument.RemoveCustomization(documentPath);
           System.Windows.Forms.MessageBox.Show("The customization has been removed.");
       }
   }
   catch (FileNotFoundException)
   {
       System.Windows.Forms.MessageBox.Show("The specified document does not exist.");
   }
   catch (IOException)
   {
       System.Windows.Forms.MessageBox.Show("The specified document is read-only.");
   }
   catch (InvalidOperationException ex)
   {
       System.Windows.Forms.MessageBox.Show("The customization could not be removed.\n" +
           ex.Message);
   }
   

4. Build the project and run the application on the computer where you want to remove the customization. The computer must have the Visual Studio 2010 Tools for Office Runtime installed.

See Also

Tasks

How to: Attach Managed Code Extensions to Documents

Concepts

Managing Documents on a Server by Using the ServerDocument Class