ServerDocument クラスを使用してサーバー上のドキュメントを管理するManage documents on a server by using the ServerDocument class

ServerDocumentでクラスを使用すると、Microsoft Office Word および Microsoft Office Excel がインストールされていない場合でも、ドキュメントレベルのカスタマイズのいくつかの側面を管理できます。 Visual Studio Tools for Office RuntimeVisual Studio Tools for Office runtimeYou can use the ServerDocument class in the Visual Studio Tools for Office RuntimeVisual Studio Tools for Office runtime to manage several aspects of document-level customizations, even if Microsoft Office Word and Microsoft Office Excel are not installed. 実行できる管理タスクは以下のとおりです。You can perform the following tasks:

ServerDocument クラスについてUnderstand the ServerDocument class

ServerDocument クラスは Office がインストールされていないコンピューターでの使用を目的としています。The ServerDocument class is designed to be used on computers that do not have Office installed. したがって、このクラスは通常、Office プロジェクトではなく、コンソール プロジェクトや Windows フォーム プロジェクトなどの Office に統合されないアプリケーションで使用します。Therefore, you typically use this class in applications that do not integrate with Office, such as Console projects or Windows Forms projects, rather than Office projects. VisualStudio アセンブリのクラスを使用します。ServerDocumentアセンブリを使用しServerDocumentます。Use the ServerDocument class in the Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll assembly.

ServerDocument クラスは、Visual Studio 2013Visual Studio 2013 を使用して作成されたドキュメント レベルのカスタマイズの操作に使用できます。The ServerDocument class can be used to operate on document-level customizations that were created by using Visual Studio 2013Visual Studio 2013.

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

Note

Visual Studio Tools for OfficeシステムのServerDocumentクラス (バージョンVisual Studio Tools for Office 3.0 ランタイム) を使用するレガシアプリケーションがある場合は、アプリケーションを実行するコンピューターにシステム (バージョン3.0 ランタイム) をインストールする必要があります。If you have a legacy application that uses the ServerDocument class in the Visual Studio Tools for Office system (version 3.0 Runtime), the Visual Studio Tools for Office system (version 3.0 runtime) must be installed on computers that run the application. Visual Studio 2010 Tools for Office runtimeは、これらのアプリケーションを実行できません。The Visual Studio 2010 Tools for Office runtime cannot run these applications.

ドキュメント内のキャッシュされたデータを操作するWork with cached data in the document

ServerDocument クラスには、カスタマイズされたドキュメント内のデータ キャッシュの操作に使用できるメンバーが用意されています。The ServerDocument class provides members you can use to work with the data cache in customized documents. キャッシュされたデータの詳細については、「サーバー上のドキュメントのデータをキャッシュし、データにアクセスする」を参照してください。For more information about cached data, see Cache data and Access data in documents on the server.

次の表は、キャッシュされたデータの操作に使用できるメンバーを示しています。The following table lists the members you can use to work with cached data.

タスクTask 使用するメンバーMember to use
ドキュメントにデータ キャッシュがあるかどうかを確認する。To determine whether a document has a data cache. IsCacheEnabled メソッド。The IsCacheEnabled method.
ドキュメント内のキャッシュされたデータにアクセスする。To access the cached data in a document.

詳細については、「サーバー上のドキュメントのデータにアクセスする」を参照してください。For more information, see Access data in documents on the server.
CachedData プロパティ。The CachedData property.

ドキュメントのカスタマイズの管理Manage the document customization

ServerDocument クラスのメンバーを使用して、ドキュメントに関連付けられているカスタマイズ アセンブリを管理できます。You can use members of the ServerDocument class to manage the customization assembly that is associated with a document. たとえば、ドキュメントのカスタマイズをプログラムによって削除し、そのドキュメントをカスタマイズから除外することもできます。For example, you can programmatically remove the customization from a document so that the document is no longer part of a customization.

次の表は、カスタマイズ アセンブリの管理に使用できるメンバーを示しています。The following table lists the members you can use to manage the customization assembly.

タスクTask 使用するメンバーMember to use
ドキュメントがドキュメント レベルのカスタマイズの一部であるかどうかを確認する。To determine whether a document is part of a document-level customization. GetCustomizationVersion メソッド。The GetCustomizationVersion method.
プログラムによって実行時にカスタマイズをドキュメントにアタッチする。To programmatically attach a customization to a document at run time.

詳細については、「方法 :マネージコード拡張機能をドキュメントにアタッチするFor more information, see How to: Attach managed code extensions to documents
AddCustomization メソッドの 1 つ。One of the AddCustomization methods.
プログラムによって実行時にドキュメントからカスタマイズを削除する。To programmatically remove a customization from a document at run time.

詳細については、「方法 :マネージコード拡張機能をドキュメントから削除します。For more information, see How to: Remove managed code Extensions from documents.
RemoveCustomization メソッド。The RemoveCustomization method.
ドキュメントに関連付けられている配置マニフェストの URL を取得する。To get the URL of the deployment manifest that is associated with the document. DeploymentManifestUrl プロパティ。The DeploymentManifestUrl property.

関連項目See also