バージョン

シリアル化プロバイダーの概要 (xamRichTextEditor)

トピックの概要

目的

このトピックでは、 xamRichTextEditor ™ コントロールのシリアル化プロバイダーについて説明します。

前提条件

このトピックをより理解するために、以下のトピックを参照することをお勧めします。

トピック 目的

このトピックでは、 xamRichTextEditor コントロールがサポートする機能の概要を説明します。

このトピックは、 xamRichTextEditor でコンテンツをプログラム処理する際に必要なドキュメントのコンテンツ論理構造を説明します。

このトピックでは、 xamRichTextEditor を短時間で起動、実行するために役立つ詳細な操作方法を紹介します。

このトピックの内容

このトピックは、以下のセクションで構成されます。

はじめに

シリアル化プロバイダーの概要

xamRichTextEditor コントロールは、シリアル化プロバイダーに基づいた柔軟なアーキテクチャをサポートします。シリアル化プロバイダーはさまざまなリッチ コンテンツ ファイル形式をインポートまたはエクスポートできます。新しいシリアル化プロバイダーを追加すると、 xamRichTextEditor でその機能を使用できます。

  • リッチ コンテンツをインポートまたはエクスポートするには、特定のシリアル化プロバイダーを設定し、 RichTextDocument コントロールの Load または Save メソッドを使用します。また Infragistics が提供する外部のシリアル化プロバイダーも、RichTextDocument の拡張メソッドを定義して、各ドキュメントを特定のファイル形式で読み込んで保存できます。詳細は、後半の関連トピックを参照してください。

  • クリップボードのカットまたはコピー操作は、 xamRichTextEditor でサポートされているすべての内部コンテンツ ファイル形式 (各種のプレーン テキスト形式)、および外部のシリアル化プロバイダーが提供する各ファイル形式で、コンテンツをクリップボードに追加します。

  • クリップボードの貼り付け操作では、外部のシリアル化プロバイダーを使用して、クリップボードのコンテンツの取得と逆シリアル化をします。このトピックの後半には、逆シリアル化の 1 つの選択肢として、ファイル形式の優先順位を定義する方法が説明されています。

以下の表は、Infragistics.WPF.RichTextDocument NuGet パッケージの内部シリアル化プロバイダーと、データをクリップボードに読み書きするときに xamRichTextEditor によって使用されるサポートされているコンテンツ形式の一覧です。

シリアル化プロバイダー ファイル形式 説明

System.String

ANSI 形式のテキスト コンテンツ

UnicodeText

Unicode 形式のテキスト コンテンツ

Text

ANSI 形式のテキスト コンテンツ

DIB

デバイスに依存しないビットマップ

注:

Note

ImageSerializationProvider は、クリップボードからの画像に対し、デバイスに依存しないビットマップ形式の読み込みのみサポートします。ドキュメントの読み込みや保存、コンテンツのクリップボードへの保存もできません。

以下の表は、追加の NuGet パッケージ内のシリアル化プロバイダーと、対応しているファイル形式の一覧です。

NuGet パッケージ / シリアル化プロバイダー フォーマット 説明

Infragistics.WPF.RichTextDocument.Rtf

RtfSerializationProvider

リッチ テキスト形式

リッチ テキスト形式のリッチ コンテンツ

Infragistics.WPF.RichTextDocument.Word

WordSerializationProvider

埋め込みソース

MS Word (docx) フォーマットのリッチ コンテンツ

シリアル化プロバイダーの構成の概要

シリアル化プロバイダーの構成の概要表

以下の表は、 xamRichTextEditor コントロールで構成できる要素を簡単に説明し、各プロパティにマップします。

構成可能な項目 詳細 プロパティ

外部のシリアル化プロバイダーを xamRichTextEditor に追加します。

クリップボードからデータを取得する時に使用するファイル形式の優先順位を設定します。

シリアル化プロバイダーの追加

概要

xamRichTextEditor がクリップボードのコンテンツの追加および取得で、追加のファイル形式をサポートできるように、xamRichTextEditor コントロールの ClipboardSerializationProviders プロパティに外部のシリアル化プロバイダーを追加できます。

プロパティ設定

以下の表では、各プロパティ設定の構成です。

目的: 使用するプロパティ: 操作:

外部シリアル化プロバイダーの追加

ClipboardSerializationProviders

外部のシリアル化プロバイダーを追加します。

例

以下のコード スニペットは、RTF と Word の外部シリアル化プロバイダーを追加する方法を示しています。

XAML の場合:

<ig:XamRichTextEditor>
    <ig:XamRichTextEditor.ClipboardSerializationProviders>
        <ig:PlainTextSerializationProvider />
        <ig:ImageSerializationProvider />
        <ig:RtfSerializationProvider />
        <ig:WordSerializationProvider />
    </ig:XamRichTextEditor.ClipboardSerializationProviders>
</ig:XamRichTextEditor>

C# の場合:

this.xamRichTextEditor1.ClipboardSerializationProviders.Add(
    PlainTextSerializationProvider.Instance);
this.xamRichTextEditor1.ClipboardSerializationProviders.Add(
    ImageSerializationProvider.Instance);
this.xamRichTextEditor1.ClipboardSerializationProviders.Add(
    RtfSerializationProvider.Instance);
this.xamRichTextEditor1.ClipboardSerializationProviders.Add(
    WordSerializationProvider.Instance);

Visual Basic の場合:

Me.xamRichTextEditor1.ClipboardSerializationProviders.Add(PlainTextSerializationProvider.Instance)
Me.xamRichTextEditor1.ClipboardSerializationProviders.Add(ImageSerializationProvider.Instance)
Me.xamRichTextEditor1.ClipboardSerializationProviders.Add(RtfSerializationProvider.Instance)
Me.xamRichTextEditor1.ClipboardSerializationProviders.Add(WordSerializationProvider.Instance)

ファイル形式の優先順位の設定

概要

クリップボードからのデータのインポートに使用するサポートされているファイル形式のリストから、各種形式の適用する順番をClipboardFormats プロパティで設定します。各ファイル形式は、プロパティで指定された順番で使用されます。各シリアル化プロバイダーの SupportedClipboardFormats プロパティを使用して、正確なフォーマットの名前を取得します。ClipboardFormats プロパティにリストされたファイル形式のみが、クリップボードのコンテンツの保存または読み込みに使用されます。デフォルトで、クリップボードには、内部および Infragistics が提供する外部のシリアル化プロバイダーによりサポートされる、すべてのファイル形式がデフォルトの選択順で含まれています。

プロパティ設定

以下の表では、各プロパティ設定の構成です。

目的: 使用するプロパティ: 設定値

ファイル形式の優先順位の設定

ClipboardFormats

読み込み順にコンマで区切られたファイル形式のリスト

例

以下のコード スニペットは、ファイル形式の優先順位を設定する方法を示します。

XAML の場合:

<ig:XamRichTextEditor ClipboardFormats="Rich Text Format, Text">
    <ig:XamRichTextEditor.ClipboardSerializationProviders>
        <ig:RtfSerializationProvider />
        <ig:WordSerializationProvider />
    </ig:XamRichTextEditor.ClipboardSerializationProviders>
</ig:XamRichTextEditor>

C# の場合:

this.xamRichTextEditor1.ClipboardSerializationProviders.ClipboardFormats =
    "Rich Text Format, Text";

Visual Basic の場合:

Me.xamRichTextEditor1.ClipboardSerializationProviders.ClipboardFormats = _
    "Rich Text Format, Text"

関連トピック

このトピックの追加情報については、以下のトピックも合わせてご参照ください。

トピック 目的

このトピックでは、 xamRichTextEditor コントロールを使用して、プレーン テキストのデータをインポートおよびエクスポートする方法を説明します。

このトピックでは、 xamRichTextEditor コントロールを使用して、RTF データをインポートおよびエクスポートする方法を説明します。

このトピックでは、 xamRichTextEditor コントロールを使用して DOCX ファイル形式のデータをインポートおよびエクスポートする方法を説明します。