TextRange クラス

定義

名前空間:

System.Windows.Documents

アセンブリ:

PresentationFramework.dll

2 つの TextPointer 位置間のコンテンツの選択を表します。

public ref class TextRange

public class TextRange

type TextRange = class

Public Class TextRange

継承

Object

TextRange

派生

System.Windows.Documents.TextSelection

例

次の例では、TextRange の Text プロパティを使用して、指定した FlowDocumentのプレーン テキスト表現を返す方法を示します。

// This method returns a plain text representation of a specified FlowDocument.
string GetTextFromFlowDocument(FlowDocument flowDoc)
{
     // Create a new TextRanage that takes the entire FlowDocument as the current selection.
     TextRange flowDocSelection = new TextRange(flowDoc.ContentStart, flowDoc.ContentEnd);
      
     // Use the Text property to extract a string that contains the unformatted text contents 
     // of the FlowDocument.
     return flowDocSelection.Text;
}

' This method returns a plain text representation of a specified FlowDocument.
Private Function GetTextFromFlowDocument(ByVal flowDoc As FlowDocument) As String
    ' Create a new TextRanage that takes the entire FlowDocument as the current selection.
    Dim flowDocSelection As New TextRange(flowDoc.ContentStart, flowDoc.ContentEnd)

    ' Use the Text property to extract a string that contains the unformatted text contents 
    ' of the FlowDocument.
    Return flowDocSelection.Text
End Function

注釈

TextRange クラスには、次の用語が導入されています。

• 選択 - TextRange は、TextPointersによって示される 2 つの位置間のコンテンツの選択です。 これらのいずれかの位置は選択に対して固定アンカーを配置し、もう一方の位置は移動可能です。 これは、マウスまたはキーボードを使用してユーザーが選択した動作に似ています。

• 現在の選択範囲 - TextRange は常にコンテンツ内の選択範囲を示すので、単に TextRange で示される選択範囲を 現在の選択範囲として参照するのが理にかなっています。

• テキスト コンテナー - テキスト コンテナー は、フロー コンテンツの最終的な境界線を形成する要素です。TextRange によって示される選択は、常にテキスト コンテナー内に含まれます。 現在、テキスト コンテナーは、FlowDocument または TextBlockである必要があります。

• ドキュメント - テキスト コンテナー内にまとめて含まれるコンテンツは、ドキュメントと呼ばれます。

位置などの他の関連用語の詳細については、TextPointerを参照してください。

コンストラクター

TextRange(TextPointer, TextPointer)

指定した 2 つの TextPointer 位置を新しい範囲の開始位置と終了位置として取得して、TextRange クラスの新しいインスタンスを初期化します。

プロパティ

End	現在の選択範囲の末尾をマークする位置を取得します。
IsEmpty	現在の選択範囲が空かどうかを示す値を取得します。
Start	現在の選択範囲の先頭を示す位置を取得します。
Text	現在の選択範囲のプレーン テキストの内容を取得または設定します。

メソッド

ApplyPropertyValue(DependencyProperty, Object)	指定した書式プロパティと値を現在の選択範囲に適用します。
CanLoad(String)	現在の選択範囲に、指定したデータ形式のコンテンツを読み込むことができるかどうかを確認します。
CanSave(String)	現在の選択範囲を指定したデータ形式で保存できるかどうかを確認します。
ClearAllProperties()	現在の選択範囲からすべての書式設定プロパティ (Inline 要素で表されます) を削除します。
Contains(TextPointer)	位置 (TextPointerで指定) が現在の選択範囲内にあるかどうかを確認します。
Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetPropertyValue(DependencyProperty)	現在の選択範囲の指定した書式設定プロパティの有効な値を返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Load(Stream, String)	指定したストリームから、指定したデータ形式で現在の選択範囲を読み込みます。
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
Save(Stream, String, Boolean)	カスタム TextElement オブジェクトを保持するオプションを使用して、現在の選択範囲を指定したデータ形式で指定したストリームに保存します。
Save(Stream, String)	現在の選択範囲を、指定したデータ形式で指定したストリームに保存します。
Select(TextPointer, TextPointer)	現在の選択範囲を更新し、更新された選択範囲を示す 2 つの TextPointer 位置を取得します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

イベント

Changed

コンテンツの新しいスパンをカバーするように範囲の位置が変更されたときに発生します。

こちらもご覧ください

• TextPointerContext