ServerDocument クラスを使用してサーバー上のドキュメントを管理する

Visual Studio Tools for Office ランタイムの ServerDocument クラスを使用すると、Microsoft Office Word と Microsoft Office Excel がインストールされていない場合でも、ドキュメント レベルのカスタマイズのさまざまな側面を管理することができます。 実行できるタスクは次のとおりです。

ServerDocument クラスについて

ServerDocument クラスは Office がインストールされていないコンピューターでの使用を目的としています。 したがって、このクラスは通常、Office プロジェクトではなく、コンソール プロジェクトや Windows フォーム プロジェクトなどの Office に統合されないアプリケーションで使用します。 Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll アセンブリの ServerDocument クラスを使用します。

ServerDocument クラスは、Visual Studio 2013 を使用して作成されたドキュメント レベルのカスタマイズの操作に使用できます。

Visual Studio 2010 Tools for Office Runtime および .NET Framework 用 Office 拡張機能の詳細については、「Visual Studio Tools for Office ランタイムの概要」を参照してください。

Note

Visual Studio Tools for Office システム (バージョン 3.0 Runtime) の ServerDocument クラスを使用するレガシ アプリケーションがある場合は、アプリケーションを実行するコンピューターに Visual Studio Tools for Office システム (バージョン 3.0 Runtime) をインストールする必要があります。 Visual Studio 2010 Tools for Office runtime では、これらのアプリケーションを実行できません。

ドキュメント内のキャッシュされたデータを操作する

ServerDocument クラスには、カスタマイズされたドキュメント内のデータ キャッシュの操作に使用できるメンバーが用意されています。 キャッシュされたデータの詳細については、「キャッシュ データ」および「サーバー上のドキュメントのデータにアクセスする」を参照してください。

次の表は、キャッシュされたデータの操作に使用できるメンバーを示しています。

タスク 使用するメンバー
ドキュメントにデータ キャッシュがあるかどうかを確認する。 IsCacheEnabled メソッド。
ドキュメント内のキャッシュされたデータにアクセスする。

詳細については、「サーバー上のドキュメントのデータにアクセスする」を参照してください。
CachedData プロパティ。

ドキュメントのカスタマイズを管理する

ServerDocument クラスのメンバーを使用して、ドキュメントに関連付けられているカスタマイズ アセンブリを管理できます。 たとえば、ドキュメントのカスタマイズをプログラムによって削除し、そのドキュメントをカスタマイズから除外することもできます。

次の表は、カスタマイズ アセンブリの管理に使用できるメンバーを示しています。

タスク 使用するメンバー
ドキュメントがドキュメント レベルのカスタマイズの一部であるかどうかを確認する。 GetCustomizationVersion メソッド。
実行時にカスタマイズをドキュメントにプログラムでアタッチする。

詳細については、「方法: マネージド コード拡張をドキュメントにアタッチする」を参照してください
AddCustomization メソッドの 1 つ。
プログラムによって実行時にドキュメントからカスタマイズを削除する。

詳細については、「方法: マネージド コード拡張をドキュメントから削除する」を参照してください。
RemoveCustomization メソッド。
ドキュメントに関連付けられている配置マニフェストの URL を取得する。 DeploymentManifestUrl プロパティ。