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

示例

下面的示例演示如何使用 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指示的两个位置之间的内容选择。 其中一个位置是相对于所选内容的固定定位点，而另一个位置是可移动的。 这类似于用户使用鼠标或键盘所做的选择的方式。

• 当前所选内容 - 由于 始终指示内容中的选定内容，因此只需将 指示的选择称为当前选定内容是有意义的。

• 文本容器 - 文本容器 是构成手头流内容的最终边框的元素;由 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, Boolean)	使用保留自定义 TextElement 对象的选项，将当前选定内容保存到指定数据格式的指定流。
Save(Stream, String)	将当前选定内容保存到指定数据格式的指定流。
Select(TextPointer, TextPointer)	更新当前所选内容，采用两个 TextPointer 位置来指示更新的选择。
ToString()	返回一个表示当前对象的字符串。 (继承自 Object)

事件

Changed

重新定位范围以覆盖新的内容范围时发生。

另请参阅

• TextPointerContext