キャッシュされたデータ

[アーティクル]
04/28/2010

更新 : 2008 年 7 月

対象
このトピックの情報は、指定された Visual Studio Tools for Office プロジェクトおよび Microsoft Office のバージョンにのみ適用されます。プロジェクトの種類ドキュメントレベルのプロジェクト Microsoft Office のバージョン 2007 Microsoft Office system Microsoft Office 2003 詳細については、「アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

このトピックの情報は、指定された Visual Studio Tools for Office プロジェクトおよび Microsoft Office のバージョンにのみ適用されます。

プロジェクトの種類

ドキュメントレベルのプロジェクト

Microsoft Office のバージョン

2007 Microsoft Office system
Microsoft Office 2003

詳細については、「アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

(Microsoft Office Word または Microsoft Office Excel を起動せず) オフラインでデータにアクセスできるように、ドキュメントレベルのカスタマイズのデータオブジェクトをキャッシュできます。オブジェクトをキャッシュするには、オブジェクトのデータ型が特定の要件を満たす必要があります。String、DataSet、および DataTable など、.NET Framework の一般的なデータ型の多くは、以下に示す要件を満たしています。

データキャッシュにオブジェクトを追加するには 2 つの方法があります。

ソリューションのビルド時にデータキャッシュにオブジェクトを追加するには、オブジェクトの宣言に CachedAttribute 属性を適用します。詳細については、「方法 : オフラインで使用するデータまたはサーバー上で使用するデータをキャッシュする」を参照してください。
実行時にプログラムでデータキャッシュにオブジェクトを追加するには、ホスト項目の StartCaching メソッド (ThisDocument クラスや ThisWorkbook クラスなど) を使用します。詳細については、「方法 : Office ドキュメント内のデータソースをプログラムでキャッシュする」を参照してください。

データキャッシュにオブジェクトを追加すると、Word や Excel を起動せずに、キャッシュされたデータにアクセスしたり、キャッシュされたデータを変更したりできます。詳細については、「サーバー上のドキュメント内のデータへのアクセス」を参照してください。

キャッシュできるデータオブジェクトの要件

作成するデータ型のインスタンスをキャッシュする場合は、そのデータ型が以下の要件を満たす必要があります。

ThisDocument クラスや ThisWorkbook クラスなど、ホスト項目の読み書き可能なパブリックフィールドまたはプロパティであること。
インデクサまたはその他のパラメータ化されたプロパティではないこと。

さらに、データオブジェクトは XmlSerializer クラスによってシリアル化できる必要があります。これは、次の特性を備えていることを意味します。

パブリック型であること。
パラメータを使用しないパブリックコンストラクタがあること。
追加のセキュリティ特権を必要とするコードを実行しないこと。
読み書き可能なパブリックプロパティのみを公開していること (それ以外のプロパティは無視されます)。
多次元配列を公開していないこと (入れ子になった配列は可)。
プロパティおよびフィールドからインターフェイスを返さないこと。
コレクションの場合、IDictionary を実装しないこと。

キャッシュされたオブジェクトの動作の制御

キャッシュされたオブジェクトの動作をより詳細に制御するには、キャッシュされたオブジェクトの型に ICachedType インターフェイスを実装します。たとえば、このインターフェイスを実装して、オブジェクト変更時のユーザーへの通知を制御できます。ICachedType を実装する方法を示すコード例については、次のサンプルアプリケーションの ControlCollection クラスを参照してください。

パスワードで保護されたドキュメント内のキャッシュされたデータに加えられた変更の永続化

Word 2007 や Excel 2007 のドキュメントレベルのプロジェクトで、パスワードで保護されたドキュメント内のデータオブジェクトをキャッシュした場合、キャッシュされたデータに加えられた変更は保存されません。Visual Studio 2008 Service Pack 1 (SP1) 以降、2 つのメソッドをオーバーライドすることで、キャッシュされたデータへの変更を保存できるようになりました。ドキュメントを保存するときにこれらのメソッドをオーバーライドして一時的に保護を解除し、保存操作が完了した後に保護を再適用します。

詳細については、「方法 : パスワードで保護されたドキュメント内のデータをキャッシュする」を参照してください。

データキャッシュに Null 値を追加するときのデータ損失の回避

データキャッシュにオブジェクトを追加するとき、キャッシュされたすべてのオブジェクトは、ドキュメントを保存して閉じる前に null 以外の値に初期化される必要があります。ドキュメントを保存して閉じるとき、キャッシュされたいずれかのオブジェクトに null 値が設定されていると、Visual Studio Tools for Office ランタイムはデータキャッシュから、キャッシュされたすべてのオブジェクトを自動的に削除します。

デザイン時に CachedAttribute 属性を使用して、null 値を設定したオブジェクトをデータキャッシュに追加した場合は、ServerDocument クラスを使用して、キャッシュされたデータオブジェクトを初期化してからドキュメントを開くことができます。この手法は、エンドユーザーがドキュメントを開く前に、Word や Excel がインストールされていないサーバー上でキャッシュされたデータを初期化する場合に便利です。詳細については、「サーバー上のドキュメント内のデータへのアクセス」を参照してください。

ドキュメントでのキャッシュされたデータの格納方法

ドキュメント内のデータオブジェクトをキャッシュするとき、Visual Studio Tools for Office ランタイムは、ドキュメントに格納されている XML 文字列にオブジェクトをシリアル化します。ドキュメントに格納される XML 文字列は、ソリューションが操作対象とする Microsoft Office のバージョンによって異なります。

Microsoft Office 2003 のカスタマイズでは、Visual Studio Tools for Office ランタイムは XML 文字列を実行時のストレージコントロールに格納します。実行時のストレージコントロールは、ドキュメントに埋め込まれる ActiveX コントロールです。詳細については、「実行時のストレージコントロールの概要」を参照してください。
2007 Microsoft Office system のカスタマイズでは、Visual Studio Tools for Office ランタイムは XML 文字列をドキュメントのカスタム XML 部分に格納します。詳細については、「カスタム XML 部分の概要」を参照してください。