ServerDocument クラスによるサーバー上のドキュメントの管理
更新 : 2007 年 11 月
対象 |
|---|
このトピックの情報は、指定された Visual Studio Tools for Office プロジェクトおよび Microsoft Office のバージョンにのみ適用されます。 プロジェクトの種類
Microsoft Office のバージョン
詳細については、「アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。 |
ServerDocument クラスを使用すると、Microsoft Office Word と Microsoft Office Excel がインストールされていない場合でも、ドキュメント レベルのカスタマイズに対してさまざまな管理タスクを行うことができます。実行できる管理タスクは以下のとおりです。
ドキュメントまたはブックのデータ キャッシュにあるデータへのアクセスおよびそのデータの変更。詳細については、「ドキュメントのキャッシュされたデータの操作」を参照してください。
ドキュメントの Visual Studio Tools for Office カスタマイズの管理。詳細については、「ドキュメントのカスタマイズの管理」を参照してください。
ServerDocument クラスについて
ServerDocument クラスには、それぞれ Visual Studio Tools for Office ランタイムの異なるバージョンに対応する 2 つのバージョンがあります。次のように、ソリューションの Microsoft Office バージョンに対応するバージョンを使用してください。
Excel 2007 および Word 2007 のカスタマイズには Microsoft.VisualStudio.Tools.Applications.ServerDocument クラスを使用します。このクラスは Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) に含まれています。
Excel 2003 および Word 2003 のカスタマイズには Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument クラスを使用します。このクラスは Visual Studio 2005 Tools for Office Second Edition Runtime に含まれています。
ServerDocument の 2 つのバージョンは機能の面で大部分が共通していますが、名前空間、アセンブリ、およびメンバの点で違いがあります。詳細については、「ServerDocument の相違点について」を参照してください。
ServerDocument クラスは Microsoft Office がインストールされていないコンピュータでの使用を目的としています。したがって、このクラスは通常、Visual Studio Tools for Office プロジェクトではなく、コンソール プロジェクトや Windows フォーム プロジェクトなどの Microsoft Office に統合されないプロジェクトで使用します。
Visual Studio Tools for Office ランタイムの各バージョンの詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。
ドキュメントのキャッシュされたデータの操作
ServerDocument クラスのどちらのバージョンにも、カスタマイズされたドキュメント内のデータ キャッシュの操作に使用できるメンバが用意されています。キャッシュされたデータの詳細については、「キャッシュされたデータ」および「サーバー上のドキュメント内のデータへのアクセス」を参照してください。
次の表は、キャッシュされたデータの操作に使用できるメンバを示しています。
タスク |
Excel 2007 プロジェクトおよび Word 2007 プロジェクト |
Excel 2003 プロジェクトおよび Word 2003 プロジェクト |
|---|---|---|
ドキュメントに Visual Studio Tools for Office データ キャッシュがあるかどうかを確認する。 |
Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) の IsCacheEnabled メソッド |
Visual Studio 2005 Tools for Office Second Edition Runtime の IsCacheEnabled メソッド |
ドキュメント内のキャッシュされたデータにアクセスする。 詳細については、「サーバー上のドキュメント内のデータへのアクセス」を参照してください。 |
Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) の CachedData プロパティ |
Visual Studio 2005 Tools for Office Second Edition Runtime の CachedData プロパティ |
ドキュメントのカスタマイズの管理
ServerDocument クラスのメンバを使用して、ドキュメントの Visual Studio Tools for Office カスタマイズを管理できます。たとえば、ドキュメントのカスタマイズをプログラムによって削除し、そのドキュメントを Visual Studio Tools for Office カスタマイズから除外することもできます。
次の表は、カスタマイズ アセンブリの管理に使用できるメンバを示しています。
タスク |
Excel 2007 プロジェクトおよび Word 2007 プロジェクト |
Excel 2003 プロジェクトおよび Word 2003 プロジェクト |
|---|---|---|
ドキュメントに Visual Studio Tools for Office カスタマイズが含まれているかどうかを確認する。 |
Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) の GetCustomizationVersion メソッド |
Visual Studio 2005 Tools for Office Second Edition Runtime の IsCustomized メソッド |
プログラムによって実行時にカスタマイズをドキュメントにアタッチする。 詳細については、次のトピックを参照してください。 |
Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) の AddCustomization メソッドの 1 つ |
Visual Studio 2005 Tools for Office Second Edition Runtime の AddCustomization メソッドの 1 つ |
プログラムによって実行時にドキュメントからカスタマイズを削除する。 詳細については、次のトピックを参照してください。 |
Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) の RemoveCustomization メソッド |
Visual Studio 2005 Tools for Office Second Edition Runtime の RemoveCustomization メソッド |
ドキュメントに関連付けられている配置マニフェストの URL を取得する。 |
Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) の DeploymentManifestUrl プロパティ |
このプロパティは Visual Studio 2005 Tools for Office Second Edition Runtime には含まれていません。Excel 2003 および Word 2003 のドキュメント レベルのソリューションでは配置マニフェストが省略可能であるためです。これらのソリューションには埋め込まれたアプリケーション マニフェストが常に付属しています。 |
ドキュメントに埋め込まれたアプリケーション マニフェストにアクセスする。 |
このプロパティは、Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) には含まれていません。Excel 2007 および Word 2007 のドキュメント レベルのソリューションには埋め込まれたアプリケーション マニフェストが付属していないからです。 |
Visual Studio 2005 Tools for Office Second Edition Runtime の AppManifest プロパティ |
ServerDocument の相違点について
ServerDocument クラスの 2 つのバージョンおよびキャッシュされたデータのオブジェクト モデルを提供する関連クラス (CachedDataHostItem や CachedDataItem など) は、異なるアセンブリおよび名前空間に定義されています。さらに、いずれかのバージョンにのみ含まれているメンバやメソッド オーバーライドもあります。こうした相違点は、次のようなシナリオで留意する必要があります。
Visual Studio 2005 Tools for Office Second Edition Runtime の ServerDocument クラスを使用するコードを Excel 2007 ソリューションおよび Word 2007 ソリューションで使用できるように移行する場合
Microsoft Office 2003 と 2007 Microsoft Office システムのドキュメント レベルのカスタマイズと連携するコードで ServerDocument クラスを使用する場合
同じコードで ServerDocument クラスの両方のバージョンを使用する方法を示す例については、「方法 : ServerDocument クラスの両方のバージョンを使用するコードを記述する」を参照してください。
名前空間とアセンブリの相違点
次の表は、ServerDocument クラスの 2 つのバージョンおよびキャッシュされたデータのオブジェクト モデルを提供する関連クラスにおける名前空間とアセンブリの相違点を示しています。
ランタイムのバージョン |
名前空間 |
アセンブリ |
|---|---|---|
Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) |
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll |
|
Visual Studio 2005 Tools for Office Second Edition Runtime |
Microsoft.VisualStudio.Tools.Applications.Runtime.dll |
メンバの相違点
次のメンバは Microsoft Visual Studio Tools for the Microsoft Office system (version 3.0 Runtime) の ServerDocument クラスにのみ含まれています。
次のメンバは Visual Studio 2005 Tools for Office Second Edition Runtime の ServerDocument クラスにのみ含まれています。
参照
処理手順
方法 : ServerDocument クラスの両方のバージョンを使用するコードを記述する
方法 : マネージ コード拡張機能をドキュメントに追加する (2007 システム)
方法 : マネージ コード拡張機能をドキュメントに追加する (2003 システム)
方法 : マネージ コード拡張機能をドキュメントから削除する (2007 システム)
方法 : マネージ コード拡張機能をドキュメントから削除する (2003 システム)
概念
Visual Studio Tools for Office Runtime の概要
参照
Microsoft.VisualStudio.Tools.Applications.ServerDocument
Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument