ServerDocument クラスによるサーバー上のドキュメントの管理
Visual Studio Tools for Office Runtime の ServerDocument クラスを使用すると、Microsoft Office Word と Microsoft Office Excel がインストールされていない場合でも、ドキュメント レベルのカスタマイズに対してさまざまな管理タスクを行うことができます。 実行できる管理タスクは以下のとおりです。
ドキュメントまたはブックのデータ キャッシュにあるデータへのアクセスおよびそのデータの変更。 詳細については、「ドキュメントのキャッシュされたデータの操作」を参照してください。
ドキュメントに関連付けられているカスタマイズ アセンブリの管理。 詳細については、「ドキュメントのカスタマイズの管理」を参照してください。
対象: このトピックの情報は、Excel 2007 と Excel 2010、および Word 2007 と Word 2010 のドキュメント レベルのプロジェクトに適用されます。詳細については、「Office アプリケーションおよびプロジェクト タイプ別の使用可能な機能」を参照してください。
ServerDocument クラスについて
ServerDocument クラスは Office がインストールされていないコンピューターでの使用を目的としています。 したがって、このクラスは通常、Office プロジェクトではなく、コンソール プロジェクトや Windows フォーム プロジェクトなどの Office に統合されないアプリケーションで使用します。
Visual Studio 2010 Tools for Office Runtime の ServerDocument クラスには 2 つの異なるバージョンがあります。使用する必要のあるバージョンは、クラスを使用するアプリケーションが対象とする .NET Framework に応じて異なります。
.NET Framework 4 を対象とするアプリケーションの場合、Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll アセンブリの Microsoft.VisualStudio.Tools.Applications.ServerDocument クラスを使用します。
.NET Framework 3.5 を対象とするアプリケーションの場合、Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll アセンブリの Microsoft.VisualStudio.Tools.Applications.ServerDocument クラスを使用します。
ServerDocument クラスのどちらのバージョンも、Visual Studio 2010 を使用して作成されたドキュメント レベルのカスタマイズ、または Visual Studio 2008 を使用して作成された Excel 2007 および Word 2007 のドキュメント レベルのカスタマイズの操作に使用できます。
Visual Studio 2010 Tools for Office Runtime および .NET Framework 用の Office 拡張機能の詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。
注意
レガシ アプリケーションで Visual Studio Tools for Office System (Version 3.0 Runtime) の ServerDocument クラスを使用する場合は、そのアプリケーションを実行するコンピューターに Visual Studio Tools for Office System (Version 3.0 Runtime) がインストールされている必要があります。 Visual Studio 2010 Tools for Office Runtime では、そうしたアプリケーションを実行できません。
ドキュメントのキャッシュされたデータの操作
ServerDocument クラスには、カスタマイズされたドキュメント内のデータ キャッシュの操作に使用できるメンバーが用意されています。 キャッシュされたデータの詳細については、「キャッシュされたデータ」および「サーバー上のドキュメント内のデータへのアクセス」を参照してください。
次の表は、キャッシュされたデータの操作に使用できるメンバーを示しています。
タスク |
使用するメンバー |
|---|---|
ドキュメントにデータ キャッシュがあるかどうかを確認する。 |
IsCacheEnabled メソッド。 |
ドキュメント内のキャッシュされたデータにアクセスする。 詳細については、「サーバー上のドキュメント内のデータへのアクセス」を参照してください。 |
CachedData プロパティ。 |
ドキュメントのカスタマイズの管理
ServerDocument クラスのメンバーを使用して、ドキュメントに関連付けられているカスタマイズ アセンブリを管理できます。 たとえば、ドキュメントのカスタマイズをプログラムによって削除し、そのドキュメントをカスタマイズから除外することもできます。
次の表は、カスタマイズ アセンブリの管理に使用できるメンバーを示しています。
タスク |
使用するメンバー |
|---|---|
ドキュメントがドキュメント レベルのカスタマイズの一部であるかどうかを確認する。 |
GetCustomizationVersion メソッド。 |
プログラムによって実行時にカスタマイズをドキュメントにアタッチする。 詳細については、「方法: マネージ コード拡張機能をドキュメントにアタッチする」を参照してください。 |
AddCustomization メソッドの 1 つ。 |
プログラムによって実行時にドキュメントからカスタマイズを削除する。 詳細については、「方法: マネージ コード拡張をドキュメントから削除する」を参照してください。 |
RemoveCustomization メソッド。 |
ドキュメントに関連付けられている配置マニフェストの URL を取得する。 |
DeploymentManifestUrl プロパティ。 |
参照
処理手順
方法: マネージ コード拡張機能をドキュメントにアタッチする
参照
Microsoft.VisualStudio.Tools.Applications.ServerDocument