ドキュメントのシリアル化および保存

  • [アーティクル]

Microsoft .NET Framework には、高品質のドキュメントを作成および表示するための強力な環境が用意されています。 固定ドキュメントとフロー ドキュメントの両方および高度な表示コントロールをサポートし、強力な 2D および 3D グラフィックス機能と組み合わされた拡張機能により、.NET Framework アプリケーションの品質とユーザー エクスペリエンスは新しいレベルになります。 ドキュメントのメモリ内の表現を柔軟に管理できることは .NET Framework の重要な機能であり、ほぼすべてのアプリケーションではデータ ストアのドキュメントを効率的に保存および読み込むことができる必要があります。 内部のメモリ内表現から外部のデータ ストアにドキュメントを変換するプロセスは、シリアル化と呼ばれます。 データ ストアを読み取って元のメモリ内インスタンスを再作成する逆のプロセスは、逆シリアル化と呼ばれます。

ドキュメントのシリアル化について

ドキュメントをメモリからシリアル化し、後で逆シリアル化してメモリに戻すプロセスは、アプリケーションに対して透過的に行われるのが理想的です。 アプリケーションは、シリアライザーの "書き込み" メソッドを呼び出してドキュメントを保存します。デシリアライザーの "読み取り" メソッドは、データ ストアにアクセスし、メモリ内の元のインスタンスを再作成します。 通常、シリアル化と逆シリアル化のプロセスで元の形式のドキュメントが再作成される限り、データが格納される特定の形式はアプリケーションにとって問題ではありません。

多くの場合、アプリケーションでは複数のシリアル化オプションが提供され、ユーザーは異なるメディアまたは異なる形式にドキュメントを保存できます。 たとえば、[名前を付けて保存] オプションでは、ドキュメントをディスク ファイル、データベース、Web サービスなどに保存できる場合があります。 同様に、別のシリアライザーでは、HTML、RTF、XML、XPS、サード パーティ形式などのさまざまな形式でドキュメントを格納できます。 アプリケーションに対して、シリアル化により、実装内のストレージ メディアの詳細を分離するインターフェイスが定義されます。 ストレージの詳細をカプセル化する利点に加え、.NET Framework の System.Windows.Documents.Serialization API には他にもいくつかの重要な機能が用意されています。

.NET Framework 3.0 ドキュメント シリアライザーの機能

  • 上位レベルのドキュメント オブジェクト (論理ツリーとビジュアル) に直接アクセスすることにより、ページ分割されたコンテンツ、2D/3D 要素、イメージ、メディア、ハイパーリンク、注釈、およびその他のサポート コンテンツの効率的な保存が可能になります。

  • 同期操作と非同期操作。

  • 拡張機能でのプラグイン シリアライザーのサポート:

    • すべての .NET Framework アプリケーションで使用するためのシステム全体のアクセス。

    • 簡単なアプリケーション プラグインの検出。

    • カスタム サードパーティ プラグインの簡単な展開、インストール、更新。

    • カスタム実行時設定とオプションのユーザー インターフェイス サポート。

XPS 印刷パス

Microsoft .NET Framework XPS の印刷パスには、印刷出力によってドキュメントを作成するための拡張メカニズムも用意されています。 XPS は、ドキュメント ファイル形式と、Windows Vista のネイティブ印刷スプール形式の両方として機能します。 XPS のドキュメントは XPS と互換性のあるプリンターに直接送信でき、中間形式に変換する必要はありません。 印刷パス出力オプションと機能について詳しくは、「印刷の概要」をご覧ください。

プラグイン シリアライザー

System.Windows.Documents.Serialization API は、プラグイン シリアライザーとリンクされたシリアライザーの両方をサポートします。リンクされたシリアライザーは、アプリケーションとは別にインストールされ、実行時にバインドされて、SerializerProvider 検出メカニズムを使ってアクセスされます。 プラグイン シリアライザーには、簡単に展開でき、システム全体で使用できるという大きな利点があります。 プラグイン シリアライザーにアクセスできない XAML ブラウザー アプリケーション (XBAP) などの部分信頼環境には、リンクされたシリアライザーを実装することもできます。 SerializerWriter クラスの派生実装に基づくリンクされたシリアライザーは、コンパイルされて、アプリケーションに直接リンクされます。 プラグイン シリアライザーとリンクされたシリアライザーはどちらも同じパブリック メソッドとイベントを通じて動作するので、同じアプリケーションでどちらか一方でも両方のシリアライザーでも簡単に使うことができます。

アプリケーション開発者にとっての利点として、プラグイン シリアライザーは新しいストレージ設計およびファイル形式に対する拡張性を備え、ビルド時に可能性のあるすべての形式を直接コーディングする必要はありません。 また、サードパーティの開発者にとっても、プラグイン シリアライザーには、カスタムまたは独自のファイル形式のためのシステムでアクセス可能なプラグインを展開、インストール、更新する標準化された手段が提供されるというメリットがあります。

プラグイン シリアライザーの使用

プラグイン シリアライザーは簡単に使うことができます。 SerializerProvider クラスを使用すると、システムにインストールされている各プラグインの SerializerDescriptor オブジェクトが列挙されます。 IsLoadable プロパティは、現在の構成に基づいてインストールされているプラグインをフィルター処理し、アプリケーションがシリアライザーを読み込んで使用できることを確認します。 SerializerDescriptor では、DisplayName や DefaultFileExtension などの他のプロパティも提供されます。アプリケーションでは、これらを使って、使用可能な出力形式のシリアライザーをユーザーに選択させることができます。 XPS 用の既定のプラグイン シリアライザーは .NET Framework で提供されており、常に列挙されます。 ユーザーが出力形式を選択した後は、CreateSerializerWriter メソッドを使って、特定の形式に対する SerializerWriter を作成します。 その後、SerializerWriter.Write メソッドを呼び出して、ドキュメント ストリームをデータ ストアに出力できます。

次の例では、"PlugInFileFilter" プロパティで SerializerProvider メソッドを使うアプリケーションを示します。 PlugInFileFilter は、インストールされているプラグインを列挙して、SaveFileDialog 用の使用可能なファイル オプションでフィルター文字列を作成します。

// ------------------------ PlugInFileFilter --------------------------
/// <summary>
///   Gets a filter string for installed plug-in serializers.</summary>
/// <remark>
///   PlugInFileFilter is used to set the SaveFileDialog or
///   OpenFileDialog "Filter" property when saving or opening files
///   using plug-in serializers.</remark>
private string PlugInFileFilter
{
    get
    {   // Create a SerializerProvider for accessing plug-in serializers.
        SerializerProvider serializerProvider = new SerializerProvider();
        string filter = "";

        // For each loadable serializer, add its display
        // name and extension to the filter string.
        foreach (SerializerDescriptor serializerDescriptor in
            serializerProvider.InstalledSerializers)
        {
            if (serializerDescriptor.IsLoadable)
            {
                // After the first, separate entries with a "|".
                if (filter.Length > 0)   filter += "|";

                // Add an entry with the plug-in name and extension.
                filter += serializerDescriptor.DisplayName + " (*" +
                    serializerDescriptor.DefaultFileExtension + ")|*" +
                    serializerDescriptor.DefaultFileExtension;
            }
        }

        // Return the filter string of installed plug-in serializers.
        return filter;
    }
}

次の例では、ユーザーが出力ファイル名を選択した後に、CreateSerializerWriter メソッドを使って指定された形式で特定のドキュメントを保存する方法を示します。

// Create a SerializerProvider for accessing plug-in serializers.
SerializerProvider serializerProvider = new SerializerProvider();

// Locate the serializer that matches the fileName extension.
SerializerDescriptor selectedPlugIn = null;
foreach ( SerializerDescriptor serializerDescriptor in
                serializerProvider.InstalledSerializers )
{
    if ( serializerDescriptor.IsLoadable &&
         fileName.EndsWith(serializerDescriptor.DefaultFileExtension) )
    {   // The plug-in serializer and fileName extensions match.
        selectedPlugIn = serializerDescriptor;
        break; // foreach
    }
}

// If a match for a plug-in serializer was found,
// use it to output and store the document.
if (selectedPlugIn != null)
{
    Stream package = File.Create(fileName);
    SerializerWriter serializerWriter =
        serializerProvider.CreateSerializerWriter(selectedPlugIn,
                                                  package);
    IDocumentPaginatorSource idoc =
        flowDocument as IDocumentPaginatorSource;
    serializerWriter.Write(idoc.DocumentPaginator, null);
    package.Close();
    return true;
}

プラグイン シリアライザーのインストール

SerializerProvider クラスは、プラグイン シリアライザーを検出してアクセスするための上位レベルのアプリケーション インターフェイスを提供します。 SerializerProvider は、システムにインストールされていてアクセスできるシリアライザーを検出し、その一覧をアプリケーションに提供します。 インストールされているシリアライザーの詳細は、レジストリ設定によって定義されます。 プラグイン シリアライザーは、RegisterSerializer メソッドを使ってレジストリに追加できます。または、.NET Framework がまだインストールされていない場合は、プラグイン インストール スクリプトを使ってレジストリ値自体を直接設定できます。 UnregisterSerializer メソッドを使って、以前にインストールされたプラグインを削除できます。または、アンインストール スクリプトでレジストリ設定を同じようにリセットできます。

プラグイン シリアライザーの作成

プラグイン シリアライザーとリンクされたシリアライザーはどちらも、同じ公開されたパブリック メソッドとイベントを使い、同期または非同期で動作するように同じように設計できます。 通常、プラグイン シリアライザーの作成には 3 つの基本的な手順があります。

  1. 最初に、シリアライザーをリンクされたシリアライザーとして実装してデバッグします。 コンパイルしてテスト アプリケーションに直接リンクするシリアライザーを最初に作成すると、テストに役立つブレークポイントや他のデバッグ サービスに完全にアクセスできます。

  2. シリアライザーを完全にテストした後、ISerializerFactory インターフェイスを追加してプラグインを作成します。 ISerializerFactory インターフェイスには論理ツリー、UIElement オブジェクト、IDocumentPaginatorSource、および Visual 要素が含まれ、.NET Framework のすべてのオブジェクトに完全にアクセスできます。 さらに、ISerializerFactory では、リンクされたシリアライザーで使われるものと同じ同期と非同期のメソッドおよびイベントが提供されます。 サイズの大きいドキュメントの出力には時間がかかる場合があるため、ユーザーの操作に応答できる状態を維持し、データ ストアで問題が発生した場合の "キャンセル" オプションを提供できるよう、非同期操作を使うことをお勧めします。

  3. プラグイン シリアライザーを作成した後、プラグインを配布してインストール (およびアンインストール) するためのインストール スクリプトを実装します (前の「プラグイン シリアライザーのインストール」を参照)。

関連項目