ServerDocument.RemoveCustomization メソッド (2007 System)

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

ドキュメントから Visual Studio Tools for Office カスタマイズを削除します。

名前空間 : Microsoft.VisualStudio.Tools.Applications
アセンブリ : Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0 (Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll 内)

構文

'宣言
Public Shared Sub RemoveCustomization ( _
    documentPath As String _
)
'使用
Dim documentPath As String

ServerDocument.RemoveCustomization(documentPath)

public static void RemoveCustomization(
    string documentPath
)

パラメータ

documentPath
型 : System.String

カスタマイズを削除するドキュメントの完全パス。

例外

例外	条件
ArgumentNullException	documentPath パラメータは、nullnull 参照 (Visual Basic では Nothing) または空であるか、完全な空白文字で構成されます。
FileNotFoundException	documentPath で指定されたファイルが存在しません。
IOException	documentPath で指定されたファイルは、読み取り専用である、またはアクセスできません。
InvalidOperationException	documentPath で指定されたファイルに Visual Studio Tools for Office カスタマイズが含まれていないか、マニフェストを読み込むときにエラーが発生しました。
DocumentCustomizedWithPreviousRuntimeException	documentPath で指定されたファイルに、以前のバージョンの Visual Studio Tools for Office ランタイムを使用して作成されたカスタマイズが含まれています。

解説

このメソッドは、配置マニフェストの URL とキャッシュされたデータマニフェストをクリアし、キャッシュされたデータをドキュメントから削除します。詳細については、「方法 : マネージコード拡張機能をドキュメントから削除する (2007 システム)」を参照してください。

例

RemoveCustomization メソッドを使用して、指定のドキュメントからカスタマイズを削除するコード例を次に示します。このコード例では、まず GetCustomizationVersion メソッドを呼び出して、ドキュメントに Visual Studio Tools for Office カスタマイズが含まれているかどうかを確認します。

この例では、Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll アセンブリと Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll アセンブリへの参照、およびコードファイルの先頭に記述された Microsoft.VisualStudio.Tools.Applications 名前空間および Microsoft.VisualStudio.Tools.Applications.Runtime 名前空間に対する Imports ステートメント (Visual Basic の場合) または using ステートメント (C# の場合) が必要です。

Private Shared Sub RemoveAssembly(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0

    Try
        ' Make sure that this customization was created using the correct runtime.
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion <> 3 Then
            MessageBox.Show("This document does not have a Visual Studio Tools for Office " & _
                "customization, or it has a customization that was created with a version of " & _
                "the runtime that is incompatible with this version of the ServerDocument class.")
            Return
        End If

        ServerDocument.RemoveCustomization(documentPath)
        MessageBox.Show("The customization has been removed.")

    Catch ex As System.IO.FileNotFoundException
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.")
    Catch ex As System.IO.IOException
        System.Windows.Forms.MessageBox.Show("The specified document is read-only.")
    Catch ex As UnknownCustomizationFileException
        System.Windows.Forms.MessageBox.Show("The specified document has a file " & _
            "extension that is not supported by Visual Studio Tools for Office.")
    Catch ex As InvalidOperationException
        System.Windows.Forms.MessageBox.Show("The customization could not be removed." & _
            vbLf & ex.Message)
    End Try
End Sub

private static void RemoveAssembly(string documentPath)
{
    int runtimeVersion = 0;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);

        // Make sure that this customization was created using the correct runtime.
        if (runtimeVersion != 3)
        {
            MessageBox.Show("This document does not have a Visual Studio Tools for " +
                "Office customization, or it has a customization that was created with " +
                "a version of the runtime that is incompatible with this version of the " +
                "ServerDocument class.");
            return;
        }

        ServerDocument.RemoveCustomization(documentPath);
        MessageBox.Show("The customization has been removed.");
    }
    catch (System.IO.FileNotFoundException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.");
    }
    catch (System.IO.IOException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document is read-only.");
    }
    catch (UnknownCustomizationFileException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document has a file " +
            "extension that is not supported by Visual Studio Tools for Office.");
    }
    catch (InvalidOperationException ex)
    {
        System.Windows.Forms.MessageBox.Show("The customization could not be removed.\n" +
            ex.Message);
    }
}