Share via

TextElement 类

  • 参考

定义

命名空间:
Microsoft.UI.Xaml.Documents
编辑

用作同样抽象 块 类和 内联 类的基类的抽象类。 TextElement 支持 XAML 文本对象模型中涉及的类的通用 API，例如控制文本大小、字体系列等的属性。

public ref class TextElement : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.WinUIContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class TextElement : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class TextElement : DependencyObject
Public Class TextElement
Inherits DependencyObject
继承
Object Platform::Object IInspectable DependencyObject TextElement
派生
属性
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

注解

TextElement 定义的各种属性支持 XAML 文本对象模型中涉及的类的通用 API。 下面是最常用的属性列表：

通过设置 TextElement 属性，可以以块和内联方式将常见的文本格式属性应用于文本。 还有其他设置文本格式的方法，但 TextElement 不直接支持这些方法。 可以改用 Typography 类的附加属性。 版式 附加属性通常支持高级版式功能或约定，例如访问在字体级别定义的不一定受所有字体支持的版式功能。 例如，可以将 Typography.Variants 设置为任何文本块或内联上的附加属性，这将影响所选用于设置 Text 元素 FontFamily 的特定字体启用的字体变体行为。

TextElement 本身并不定义 XAML 可视化树的连接点。 换句话说，TextElement 定义该文本中的文本和文本对象模型，但它尚未在 UI 中启用该文本的显示。 为此，需要使用属于 UIElement 后代的控件或元素之一，这些控件或元素可以连接到应用窗口的 XAML 树和根视觉对象。 Windows 运行时中有两个此类元素：

  • TextBlock：仅支持其 Inlines 集合的 内联 文本对象模型。
  • RichTextBlock：支持块文本对象模型及其 Blocks 集合。 块可以包含块和内联。

注意

PasswordBox、 RichEditBox 和 TextBox 不支持基于 TextElement 的文本对象模型。 RichEditBox 支持通过 ITextDocument 接口以编程方式访问其他文本对象模型。

TextElement 定义了支持在分析 XAML 后将文本对象模型检查为编程对象的 API。 特别是 TextElement 实现 Name 和 Language，这些名称在 FrameworkElement 上具有相同名称的并行属性。 TextElement 还实现 FindName (一种实用工具方法，用于根据初始 XAML) 中设置 Name 的方式在运行时查找对象，以及针对高级方案和设计器支持) 的 OnDisconnectVisualChildren (。

TextElement 有四个属性，这些属性提供对 文本内 TextPointer 对象的访问。 这些属性包括： ContentStart、 ContentEnd、 ElementStart、 ElementEnd。 Windows 运行时 TextPointer 对象提供用于遍历内容的入口点。 有关详细信息，请参阅 TextPointer。

TextElement 是派生自 DependencyObject 的类。 这意味着它可以定义依赖属性，TextElement 的每个读写属性都是依赖属性，其属性标识符也由 TextElement 定义。 有关启用哪些依赖属性的详细信息，请参阅 依赖项属性概述。

TextElement 派生类

TextElement 是两个派生类的父类，这些类将文本对象模型拆分为两个文本使用约定： Block 和 Inline。 块 和 内联 都被视为基类， (通常不会在 XAML) 中看到 <Block> 标记，并且存在于层次结构中，主要是作为其他实际文本元素的父类。 例如， Block 是 Paragraph 的父类。 有关如何使用块和内联元素的详细信息，请参阅 文本块。

属性

AccessKey

获取或设置此元素的访问键。
AccessKeyProperty

标识 AccessKey 依赖属性。
AccessKeyScopeOwner

获取或设置一个源元素，该元素提供此元素的访问键范围，即使它不在源元素的可视化树中也是如此。
AccessKeyScopeOwnerProperty

标识 AccessKeyScopeOwner 依赖属性。
AllowFocusOnInteraction

获取或设置一个值，该值指示当用户与元素交互时是否自动获取焦点。
AllowFocusOnInteractionProperty

标识 AllowFocusOnInteraction 依赖属性。
CharacterSpacing

获取或设置字符之间的统一间距，单位为 1/1000 em。
CharacterSpacingProperty

标识 CharacterSpacing 依赖属性。
ContentEnd

获取一个 TextPointer ，它表示 元素中内容的末尾。
ContentStart

获取一个 TextPointer ，它表示 元素中内容的开头。
Dispatcher

始终在Windows 应用 SDK应用中返回 null 。 请改用 DispatcherQueue 。

(继承自 DependencyObject)
DispatcherQueue

DispatcherQueue获取与此对象关联的 。 表示 DispatcherQueue 一个可以在 UI 线程上访问 DependencyObject 的设施，即使代码是由非 UI 线程启动的。

(继承自 DependencyObject)
ElementEnd

获取一个 TextPointer ，它表示元素末尾之后的位置。
ElementStart

获取一个 TextPointer ，它表示元素开始之前的位置。
ExitDisplayModeOnAccessKeyInvoked

获取或设置一个值，该值指定在调用访问密钥时是否消除访问密钥显示。
ExitDisplayModeOnAccessKeyInvokedProperty

标识 ExitDisplayModeOnAccessKeyInvoked 依赖属性。
FontFamily

获取或设置元素内容的首选顶级字体系列。
FontFamilyProperty

标识 FontFamily 依赖属性。
FontSize

获取或设置元素内容的字体大小。
FontSizeProperty

标识 FontSize 依赖属性。
FontStretch

获取或设置系列中要选择的字体的字形宽度。
FontStretchProperty

标识 FontStretch 依赖属性。
FontStyle

获取或设置此元素中内容的字体样式。
FontStyleProperty

标识 FontStyle 依赖属性。
FontWeight

获取或设置要从此元素中内容的字体系列中选择的顶级字体粗细。
FontWeightProperty

标识 FontWeight 依赖属性。
Foreground

获取或设置要应用于此元素中内容的 Brush 。
ForegroundProperty

标识 前台 依赖属性。
IsAccessKeyScope

获取或设置一个值，该值指示元素是否定义其自己的访问键范围。
IsAccessKeyScopeProperty

标识 IsAccessKeyScope 依赖属性。
IsTextScaleFactorEnabled

获取或设置是否启用自动文本放大，以反映系统文本大小设置。
IsTextScaleFactorEnabledProperty

标识 IsTextScaleFactorEnabled 依赖属性。
KeyTipHorizontalOffset

获取或设置一个值，该值指示键提示相对于文本元素的左或右放置位置。
KeyTipHorizontalOffsetProperty

标识 KeyTipHorizontalOffset 依赖属性。
KeyTipPlacementMode

获取或设置一个值，该值指示键提示相对于文本元素放置的位置。
KeyTipPlacementModeProperty

标识 KeyTipPlacementMode 依赖属性。
KeyTipVerticalOffset

获取或设置一个值，该值指示键提示相对于文本元素的向上或向下放置距离。
KeyTipVerticalOffsetProperty

标识 KeyTipVerticalOffset 依赖属性。
Language

获取或设置应用于 TextElement 的本地化/全球化语言信息。
LanguageProperty

标识 Language 依赖属性。
Name

获取或设置 对象的唯一标识。 只能从 XAML 的初始分析中设置名称。
TextDecorations

获取或设置一个值，该值指示应用于文本的修饰。
TextDecorationsProperty

标识 TextDecorations 依赖属性。
XamlRoot

获取或设置在其中查看此元素的 XamlRoot。

方法

ClearValue(DependencyProperty)

清除依赖属性的本地值。

(继承自 DependencyObject)
FindName(String)

通过引用对象的 x：Name 或 Name 属性值，在对象模型/运行时对象图中检索对象。
GetAnimationBaseValue(DependencyProperty)

返回为依赖属性建立的任何基值，该基值适用于动画未处于活动状态的情况。

(继承自 DependencyObject)
GetValue(DependencyProperty)

从 DependencyObject 返回依赖属性的当前有效值。

(继承自 DependencyObject)
OnDisconnectVisualChildren()

重写此方法以实现从特定于类的内容或子属性中删除项时布局和逻辑的行为方式。
ReadLocalValue(DependencyProperty)

如果设置了本地值，则返回依赖属性的本地值。

(继承自 DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

注册通知函数，用于侦听此 DependencyObject 实例上对特定 DependencyProperty 的更改。

(继承自 DependencyObject)
SetValue(DependencyProperty, Object)

设置 DependencyObject 上依赖属性的本地值。

(继承自 DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

取消以前通过调用 RegisterPropertyChangedCallback 注册的更改通知。

(继承自 DependencyObject)

事件

AccessKeyDisplayDismissed

当访问键序列完成时发生，以通知控件应隐藏访问键视觉对象。
AccessKeyDisplayRequested

当访问键序列启动以通知控件它们应显示访问键视觉对象时发生。
AccessKeyInvoked

当用户完成访问键序列以通知元素应调用访问键操作时发生。

适用于

另请参阅