ServerDocument.RemoveCustomization メソッド
ドキュメントからカスタマイズを削除します。
名前空間: Microsoft.VisualStudio.Tools.Applications
アセンブリ: Microsoft.VisualStudio.Tools.Applications.ServerDocument (Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll 内)
構文
'宣言
Public Shared Sub RemoveCustomization ( _
documentPath As String _
)
public static void RemoveCustomization(
string documentPath
)
パラメーター
- documentPath
型 : System.String
カスタマイズを削除するドキュメントの完全パス。
例外
| 例外 | 条件 |
|---|---|
| ArgumentNullException | documentPath パラメーターは、nullnull 参照 (Visual Basic では Nothing) または空であるか、完全な空白文字で構成されます。 |
| FileNotFoundException | documentPath で指定されたファイルが存在しません。 |
| IOException | documentPath で指定されたファイルは、読み取り専用である、またはアクセスできません。 |
| InvalidOperationException | documentPath で指定されたファイルにカスタマイズが含まれていないか、マニフェストを読み込むときにエラーが発生しました。 |
| DocumentCustomizedWithPreviousRuntimeException | documentPath で指定されたファイルには、Visual Studio 2010 Tools for Office Runtime または Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) 以外で作成されたカスタマイズが含まれています。 |
解説
このメソッドは、配置マニフェストの URL とキャッシュされたデータ マニフェストをクリアし、キャッシュされたデータをドキュメントから削除します。詳細については、「方法: マネージ コード拡張をドキュメントから削除する」を参照してください。
例
RemoveCustomization メソッドを使用して、指定のドキュメントからカスタマイズを削除するコード例を次に示します。このコード例では、まず GetCustomizationVersion メソッドを呼び出して、ドキュメントにカスタマイズが含まれているかどうかを確認します。
この例には、次の項目が必要です。
コンソール アプリケーション プロジェクトまたはその他の Office 以外のプロジェクト。
次のアセンブリへの参照。
(プロジェクトが .NET Framework 4 か .NET Framework 4.5を対象としている場合) Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll および Microsoft.VisualStudio.Tools.Applications.Runtime.dll。
または
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll および Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (プロジェクトが .NET Framework 3.5 を対象とする場合)。
コード ファイルの先頭に、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);
}
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。
参照
関連項目
Microsoft.VisualStudio.Tools.Applications 名前空間