TextRange 类

定义

命名空间:

System.Windows.Documents

程序集:

PresentationFramework.dll

表示两个 TextPointer 位置之间的所选内容。

public ref class TextRange

public class TextRange

type TextRange = class

Public Class TextRange

继承

Object

TextRange

派生

System.Windows.Documents.TextSelection

示例

以下示例演示如何使用 Text a TextRange 属性返回指定 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 类引入了以下术语。

• 选择 - A TextRange 是 TextPointers 指示的两个位置之间的内容选择。 其中一个位置是相对于所选内容的固定定位点，而另一个位置是可移动的。 这类似于使用鼠标或键盘的用户所做的选择。

• 当前选择 - 因为始终 TextRange 指示内容中的选定内容，因此只需将所选内容指示 TextRange 为 当前所选内容的选定 内容即可。

• 文本容器 - 文本容器 是构成手头流内容的最终边框的元素;由 TextRange 始终位于文本容器内的选定内容。 目前，文本容器必须是一个 FlowDocument 或一个 TextBlock。

• 文档 - 文本容器中统一包含的内容称为 文档。

有关其他相关术语（如 位置）的详细信息，请参阅 TextPointer。

构造函数

TextRange(TextPointer, TextPointer)

初始化 TextRange 类的新实例，将两个指定的 TextPointer 位置作为新范围的开始和结束位置。

属性

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)	将当前所选内容以指定数据格式保存到指定流中。
Save(Stream, String, Boolean)	将当前所选内容以指定数据格式保存到指定流中，同时选择保留自定义 TextElement 对象。
Select(TextPointer, TextPointer)	更新当前所选内容，使用两个 TextPointer 位置来指示更新的所选内容。
ToString()	返回表示当前对象的字符串。 (继承自 Object)

事件

Changed

在确定区域以覆盖新的内容范围时发生。

另请参阅

• TextPointerContext