This topic has not yet been rated - Rate this topic

ServerDocument.RemoveCustomization Method (2003 System)

Updated: November 2007

Removes the Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0) customization from the document.

Namespace:  Microsoft.VisualStudio.Tools.Applications.Runtime
Assembly:  Microsoft.VisualStudio.Tools.Applications.Runtime (in Microsoft.VisualStudio.Tools.Applications.Runtime.dll)
public static void RemoveCustomization(
	string documentPath
)

Parameters

documentPath
Type: System.String
The full path of the document from which you want to remove the customization.
Exception Condition
ArgumentNullException

The documentPath parameter is null or empty or consists entirely of white space characters.

FileNotFoundException

The file specified by documentPath does not exist.

IOException

The file specified by documentPath is read-only, or cannot be accessed.

InvalidOperationException

The file specified by documentPath does not have a Visual Studio Tools for Office customization, or an error occurred while loading the manifest.

This method clears the application manifest and the cached data manifest, and removes any cached data from the document. For more information, see How to: Remove Managed Code Extensions from Documents (2003 System).

The following code example uses the RemoveCustomization method to remove the customization from the specified document. The example first calls the IsCustomized method to determine whether the document has a Visual Studio Tools for Office customization. This example requires a reference to the Microsoft.VisualStudio.Tools.Applications.Runtime assembly, and an Imports (for Visual Basic) or using (for C#) statement for the Microsoft.VisualStudio.Tools.Applications.Runtime namespace at the top of your code file.

private static void Remove(string fileName)
{
    if (ServerDocument.IsCustomized(fileName))
    {
        ServerDocument.RemoveCustomization(fileName);
        MessageBox.Show("The customization has been removed.");
    }
    else
    {
        MessageBox.Show("The specified document is not " +
            "customized.");
    }
}


Did you find this helpful?
(1500 characters remaining)