TextElement Класс

Определение

Абстрактный класс, используемый в качестве базового класса для также абстрактных классов Block и Inline . TextElement поддерживает общий API для классов, участвующих в текстовой объектной модели XAML, таких как свойства, управляющие размером текста, семействами шрифтов и т. д.

public ref class TextElement : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 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(Windows.Foundation.UniversalApiContract), 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
Производный
Атрибуты

Требования к Windows

Семейство устройств
Windows 10 (появилось в 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (появилось в v1.0)

Комментарии

Различные свойства, определенные TextElement, поддерживают общий API для классов, участвующих в текстовой объектной модели XAML. Ниже приведен список наиболее часто используемых свойств.

Задав свойства TextElement, вы можете применить к тексту общие свойства форматирования текста как в блоках, так и в строках. Существуют также дополнительные способы форматирования текста, но они не поддерживаются непосредственно TextElement. Вместо этого можно использовать присоединенные свойства класса Typography . Присоединенные свойства типографии обычно поддерживают расширенные типографические функции или соглашения, такие как доступ к типографическим функциям, определенным на уровне шрифта, которые не обязательно поддерживаются всеми шрифтами. Например, вы можете задать Typography.Variants в качестве присоединенного свойства для любого блока текста или встроенного текста, и это повлияет на поведение вариантов шрифтов, включаемое определенным шрифтом, выбранным для настройки FontFamily для этого текстового элемента.

TextElement не определяет точку подключения к визуальному дереву XAML. Другими словами, TextElement определяет текст и текстовую объектную модель в этом тексте, но пока не позволяет отображать этот текст в пользовательском интерфейсе. Для этого необходимо использовать один из элементов управления или элементов, которые являются потомками UIElement и могут быть подключены к дереву XAML и корневому визуальному элементу окна приложения. В среда выполнения Windows есть два таких элемента:

  • TextBlock: поддерживает текстовую объектную модель строк только с коллекцией Inlines .
  • RichTextBlock: поддерживает объектную модель блочного текста с ее коллекцией Blocks . Блоки могут содержать блоки и встроенные элементы.

Примечание

PasswordBox, RichEditBox и TextBox не поддерживают текстовую объектную модель, основанную на TextElement. RichEditBox обеспечивает программный доступ к другой текстовой объектной модели через интерфейс ITextDocument .

TextElement определяет API, который поддерживает проверку текстовой объектной модели как программных объектов после анализа XAML. В частности, TextElement реализует Name и Language, которые параллельно свойства с тем же именем в FrameworkElement. TextElement также реализует FindName (служебный метод для поиска объектов во время выполнения на основе того, как имя было задано в начальном коде XAML) и OnDisconnectVisualChildren (для расширенных сценариев и поддержки конструктора).

TextElement имеет четыре свойства, которые предоставляют доступ к объектам TextPointer из текста. Эти свойства: ContentStart, ContentEnd, ElementStart, ElementEnd. Объект TextPointer среда выполнения Windows предоставляет точку входа для обхода содержимого. Дополнительные сведения см. в разделе TextPointer.

TextElement — это класс, производный от DependencyObject. Это означает, что он может определять свойства зависимостей, и каждое из свойств чтения и записи TextElement является свойством зависимостей, идентификатор свойства также определяется TextElement. Дополнительные сведения о том, какие свойства зависимостей можно включить, см. в статье Общие сведения о свойствах зависимостей.

Производные классы TextElement

TextElement — это родительский класс для двух производных классов, которые разделяют текстовую объектную модель на два соглашения об использовании текста: Block и Inline. Block и Inline считаются базовыми классами (тег в XAML обычно не отображается <Block> ) и существуют в иерархии главным образом для того, чтобы быть родительским классом других практических текстовых элементов. Например, Block является родительским классом Paragraph. Дополнительные сведения об использовании блочных и встроенных элементов см. в статье Краткое руководство. Отображение текста.

Журнал версий

Версия Windows Версия пакета SDK Добавленная стоимость
1607 14393 AccessKey
1607 14393 AllowFocusOnInteraction
1607 14393 ExitDisplayModeOnAccessKeyInvoked
1703 15063 AccessKeyDisplayDismissed
1703 15063 AccessKeyDisplayRequested
1703 15063 AccessKeyInvoked
1703 15063 AccessKeyScopeOwner
1703 15063 IsAccessKeyScope
1703 15063 KeyTipHorizontalOffset
1703 15063 KeyTipPlacementMode
1703 15063 KeyTipVerticalOffset
1703 15063 TextDecorations
1903 18362 XamlRoot

Свойства

AccessKey

Возвращает или задает ключ доступа для этого элемента.

AccessKeyProperty

Определяет свойство зависимостей AccessKey .

AccessKeyScopeOwner

Возвращает или задает исходный элемент, предоставляющий ключ доступа область для этого элемента, даже если он не находится в визуальном дереве исходного элемента.

AccessKeyScopeOwnerProperty

Определяет свойство зависимостей AccessKeyScopeOwner .

AllowFocusOnInteraction

Возвращает или задает значение, указывающее, получает ли элемент фокус автоматически, когда пользователь взаимодействует с ним.

AllowFocusOnInteractionProperty

Определяет свойство зависимости AllowFocusOnInteraction .

CharacterSpacing

Возвращает или задает равномерный интервал между символами в единицах 1/1000 em.

CharacterSpacingProperty

Определяет свойство зависимости CharacterSpacing .

ContentEnd

Возвращает объект TextPointer , представляющий конец содержимого в элементе .

ContentStart

Возвращает объект TextPointer , представляющий начало содержимого в элементе .

Dispatcher

Возвращает объект CoreDispatcher , с которым связан этот объект. CoreDispatcher представляет собой средство, которое может получить доступ к DependencyObject в потоке пользовательского интерфейса, даже если код инициируется потоком, не относящегося к пользовательскому интерфейсу.

(Унаследовано от DependencyObject)
ElementEnd

Возвращает объект TextPointer , представляющий позицию сразу после конца элемента.

ElementStart

Возвращает объект TextPointer , представляющий позицию непосредственно перед началом элемента.

ExitDisplayModeOnAccessKeyInvoked

Возвращает или задает значение, указывающее, закрывается ли отображение ключа доступа при вызове ключа доступа.

ExitDisplayModeOnAccessKeyInvokedProperty

Определяет свойство зависимости ExitDisplayModeOnAccessKeyInvoked .

FontFamily

Возвращает или задает предпочтительное семейство шрифтов верхнего уровня для содержимого элемента.

FontFamilyProperty

Определяет свойство зависимости FontFamily .

FontSize

Получает или задает размер шрифта для содержимого элемента.

FontSizeProperty

Определяет свойство зависимости FontSize .

FontStretch

Возвращает или задает ширину глифа шрифта в семействе для выбора.

FontStretchProperty

Определяет свойство зависимости FontStretch .

FontStyle

Возвращает или задает стиль шрифта для содержимого в этом элементе.

FontStyleProperty

Определяет свойство зависимости FontStyle .

FontWeight

Возвращает или задает вес шрифта верхнего уровня, выбираемый из семейства шрифтов для содержимого в этом элементе.

FontWeightProperty

Определяет свойство зависимости FontWeight .

Foreground

Возвращает или задает кисть для применения к содержимому в этом элементе.

ForegroundProperty

Идентифицирует свойство зависимости переднего плана .

IsAccessKeyScope

Возвращает или задает значение, указывающее, определяет ли элемент собственный ключ доступа область.

IsAccessKeyScopeProperty

Определяет свойство зависимости IsAccessKeyScope .

IsTextScaleFactorEnabled

Возвращает или задает значение, указывающее, включено ли автоматическое увеличение текста в соответствии с параметром системного размера текста.

IsTextScaleFactorEnabledProperty

Определяет свойство зависимости IsTextScaleFactorEnabled .

KeyTipHorizontalOffset

Возвращает или задает значение, указывающее, насколько далеко слева или справа расположена подсказка клавиши относительно текстового элемента.

KeyTipHorizontalOffsetProperty

Определяет свойство зависимости KeyTipHorizontalOffset .

KeyTipPlacementMode

Возвращает или задает значение, указывающее, где находится подсказка клавиши относительно текстового элемента.

KeyTipPlacementModeProperty

Определяет свойство зависимости KeyTipPlacementMode .

KeyTipVerticalOffset

Возвращает или задает значение, указывающее, насколько далеко расположена подсказка клавиши по отношению к текстовому элементу.

KeyTipVerticalOffsetProperty

Определяет свойство зависимости KeyTipVerticalOffset .

Language

Возвращает или задает сведения о языке локализации и глобализации, которые применяются к Элементу TextElement.

LanguageProperty

Определяет свойство Языковой зависимости.

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)

Регистрирует функцию уведомления для прослушивания изменений определенного DependencyProperty в этом экземпляре DependencyObject .

(Унаследовано от DependencyObject)
SetValue(DependencyProperty, Object)

Задает локальное значение свойства зависимостей для Объекта DependencyObject.

(Унаследовано от DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Отменяет уведомление об изменениях, которое было ранее зарегистрировано путем вызова Метода RegisterPropertyChangedCallback.

(Унаследовано от DependencyObject)

События

AccessKeyDisplayDismissed

Происходит после завершения последовательности ключей доступа для уведомления элементов управления о том, что они должны скрывать визуальные элементы ключа доступа.

AccessKeyDisplayRequested

Происходит при запуске последовательности ключей доступа для уведомления элементов управления о том, что они должны отображать визуальные элементы ключа доступа.

AccessKeyInvoked

Происходит, когда пользователь завершает последовательность клавиш доступа, чтобы уведомить элемент о том, что необходимо вызвать действие ключа доступа.

Применяется к

См. также раздел