RichTextLabel
Метка для текста с BBCode, встроенными объектами и эффектами.
RichTextLabel отображает форматированный текст. Для статической строки включите BbcodeEnabled и назначьте Text; для последовательного построения используйте Push-методы, AddText и Pop. AddText выводит скобки и теги буквально, AppendText разбирает BBCode. Не смешивайте исходное Text и ручное построение без явного сброса: Text не становится копией получившегося содержимого.
Метка не является редактором кода или HTML-браузером. Метаданные ссылки передаются приложению через MetaClicked; переход выполняет обработчик. Пользовательские эффекты меняют отрисовку глифов, а не исходный текст.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Конструкторы1
RichTextLabelКонструктор
public RichTextLabel();Создаёт метку форматированного текста; добавьте её родителю через AddChild. Для разбора Text как BBCode включите BbcodeEnabled. Не открывает файлы или ссылки автоматически.
Свойства33
AutowrapModeСвойство
public TextServer.AutowrapMode AutowrapMode { get; set; }Правило переноса по доступной ширине: отключение, произвольный перенос или перенос по словам. Меняет визуальные строки и размеры, сохраняя исходный Text. Для предсказуемого результата задайте метке ширину через компоновку.
AutowrapTrimFlagsСвойство
public TextServer.LineBreakFlag AutowrapTrimFlags { get; set; }Флаги обработки краевых пробелов и отступа при переносе. Setter сохраняет только биты trim-маски TextServer; другие LineBreakFlag не включают здесь собственный режим переноса. Исходный текст не обрезается.
BbcodeEnabledСвойство
public bool BbcodeEnabled { get; set; }Определяет разбор свойства Text как BBCode. Для ручного AddText разбор не включается; AppendText самостоятельно разбирает разметку. Переключение настройки не гарантирует перестройку вручную изменённого стека.
ContextMenuEnabledСвойство
public bool ContextMenuEnabled { get; set; }Разрешает открытие встроенного пользовательского меню. false не удаляет PopupMenu и не запрещает программные GetMenu/MenuOption. Это настройка интерфейса, а не запрет копирования данных приложением.
CustomEffectsСвойство
public Reckfell.Collections.Array CustomEffects { get; set; }Ресурсы пользовательских BBCode-эффектов. Setter заменяет массив и вызывает ReloadEffects; getter разделяет массив, поэтому изменение результата само по себе не перезапускает разбор. Эффекты с совпадающими именами неоднозначны: используется первое подходящее имя. Для прямого программного применения используйте PushCustomfx.
DeselectOnFocusLossEnabledСвойство
public bool DeselectOnFocusLossEnabled { get; set; }Разрешает снятие выделения при потере фокуса. При переключении false → true у метки без фокуса существующее выделение снимается сразу. Для сохранения выделения при переходе к другому элементу используйте false.
DragAndDropSelectionEnabledСвойство
public bool DragAndDropSelectionEnabled { get; set; }Разрешает пользовательское перетаскивание выделенного обычного текста из метки. Нужно SelectionEnabled; не включает редактирование или приём произвольных файлов. Назначение свойства не запускает перенос.
FitContentСвойство
public bool FitContent { get; set; }Учитывает содержимое в минимальном размере метки. Родительский контейнер может расширить элемент; это не команда установить точный Size и не уменьшение шрифта. Учитывайте взаимодействие с переносами и ограничениями родителя.
HintUnderlinedСвойство
public bool HintUnderlined { get; set; }Разрешает визуальное подчёркивание областей PushHint. Не включает или отключает само содержимое подсказки и не меняет текст.
HorizontalAlignmentСвойство
public HorizontalAlignment HorizontalAlignment { get; set; }Выравнивание основного текста по горизонтали; локальная разметка абзаца может задавать своё. Fill использует JustificationFlags для выравнивания по ширине. Не перемещает сам Control в родительском контейнере.
JustificationFlagsСвойство
public TextServer.JustificationFlag JustificationFlags { get; set; }Правила растяжения строк при выравнивании по ширине, например обработка слов и последней строки. Действуют вместе с соответствующим выравниванием; не задают ширину метки.
LanguageСвойство
public string Language { get; set; }Языковая подсказка текстовой системе для формирования и переноса. Не переводит строку на другой язык; перевод UI исходного Text — отдельный механизм.
MaximumFontSizeСвойство
public int MaximumFontSize { get; set; }Верхняя граница подбора при ResizeFontToFit. Согласуйте с MinimumFontSize; это ограничение подбора, а не общий запрет локальных размеров BBCode.
MetaUnderlinedСвойство
public bool MetaUnderlined { get; set; }Разрешает подчёркивание областей метаданных с учётом их MetaUnderline. Не создаёт ссылку и не открывает URL. Явная область PushUnderline остаётся отдельным форматированием.
MinimumFontSizeСвойство
public int MinimumFontSize { get; set; }Нижняя граница подбора при ResizeFontToFit. Задавайте положительное значение не больше MaximumFontSize. Само назначение не означает, что именно этот размер уже нарисован.
ProgressBarDelayСвойство
public int ProgressBarDelay { get; set; }Задержка показа индикатора фоновой загрузки в миллисекундах. Положительное значение ждёт этот интервал; 0 и отрицательные значения отключают индикатор. Не задаёт скорость разбора или задержку появления символов.
ResizeFontToFitСвойство
public bool ResizeFontToFit { get; set; }Разрешает подбирать размер основного шрифта для доступной области в диапазоне MinimumFontSize–MaximumFontSize. Не заменяет FitContent: здесь меняется шрифт, а не требование минимального размера. Подбор зависит от ширины и высоты; слишком маленький минимум не гарантирует читаемость.
ScrollActiveСвойство
public bool ScrollActive { get; set; }Разрешает встроенную вертикальную прокрутку. Переключение вызывает повторное применение исходного Text: при смешении с ручным AddText/Push содержимое может быть перестроено из сохранённой строки. Задавайте режим до ручного построения. Не означает, что всё содержимое помещается без полосы.
ScrollFollowingСвойство
public bool ScrollFollowing { get; set; }Разрешает следование за концом дополняемого текста. Если пользователь прокрутил вверх, фактическое следование может приостановиться до возвращения к низу. Getter сообщает настройку, а не факт положения внизу.
ScrollFollowingVisibleCharactersСвойство
public bool ScrollFollowingVisibleCharacters { get; set; }Прокручивает к области, раскрываемой через VisibleCharacters. Отличается от следования за полным концом текста: предназначено для постепенного показа. Назначение true может сразу изменить прокрутку.
SelectionEnabledСвойство
public bool SelectionEnabled { get; set; }Разрешает выделение отображаемого текста и SelectAll. Включение задаёт FocusMode.All; отключение снимает активное выделение и устанавливает режим фокуса доступности. Не делает метку редактируемой и не изменяет Text.
ShortcutKeysEnabledСвойство
public bool ShortcutKeysEnabled { get; set; }Разрешает встроенные сочетания команд метки. Не включает SelectionEnabled автоматически и не запрещает прямые программные вызовы SelectAll/MenuOption.
StructuredTextBidiOverrideСвойство
public TextServer.StructuredTextParser StructuredTextBidiOverride { get; set; }Выбирает разбор структурированного двунаправленного текста, например адресов и путей. Это настройка формирования, не regex-замена исходной строки. Параметры задаёт StructuredTextBidiOverrideOptions.
StructuredTextBidiOverrideOptionsСвойство
public Reckfell.Collections.Array StructuredTextBidiOverrideOptions { get; set; }Параметры структурированного BiDi-разбора. Массив сохраняется по общей ссылке; изменение его содержимого не запускает перерасчёт автоматически. Для обновления назначьте новый массив с отличающимся содержимым: равное содержимое setter может пропустить.
TabSizeСвойство
public int TabSize { get; set; }Ширина стандартного шага табуляции в пробелах; используйте положительное значение. Меняет отображение tab, не заменяет его пробелами в Text. Для явных позиций используйте TabStops.
TabStopsСвойство
public float[] TabStops { get; set; }Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.
TextСвойство
public string Text { get; set; }Исходная строка для полного построения метки, с переводом UI и разбором BBCode при включённом BbcodeEnabled. Назначение заменяет ручное содержимое; одинаковая непустая строка может ничего не перестроить. AddText, AppendText и Push-методы не дописывают сюда свой результат. Для получившегося обычного текста используйте GetParsedText.
TextDirectionСвойство
public Control.TextDirection TextDirection { get; set; }Направление текста для BiDi-формирования. Не переставляет символы исходной строки вручную и не переводит текст. Разметка структурированного текста настраивается отдельно.
ThreadedСвойство
public bool Threaded { get; set; }Разрешает фоновый расчёт раскладки текста; по умолчанию false. Не делает произвольные вызовы RichTextLabel потокобезопасными и не переносит всю отрисовку в другой поток. Следите за IsFinished; до завершения метрики могут описывать только обработанную часть.
VerticalAlignmentСвойство
public VerticalAlignment VerticalAlignment { get; set; }Размещение текстового содержимого по вертикали внутри области метки. Не меняет вертикальное выравнивание Control у родителя и не включает автоматическую прокрутку.
VisibleCharactersСвойство
public int VisibleCharacters { get; set; }Лимит постепенного показа: -1 показывает всё, 0 скрывает текст, неотрицательное значение задаёт предел. Поведение до/после формирования глифов выбирает VisibleCharactersBehavior. Это не количество кадров и не UTF-16 Length строки Text. Setter пересчитывает VisibleRatio, но не ограничивает явно слишком большое значение; для анимации держите диапазон от 0 до GetTotalCharacterCount.
VisibleCharactersBehaviorСвойство
public TextServer.VisibleCharactersBehavior VisibleCharactersBehavior { get; set; }Определяет, применяется ли лимит до формирования текста или к уже сформированным символам/глифам. До формирования может меняться раскладка; после формирования сохраняется контекст полной строки, но единицы показа зависят от режима. Учитывайте лигатуры, составные символы и RTL; не предполагайте один char C# на один видимый глиф.
VisibleRatioСвойство
public float VisibleRatio { get; set; }Доля показа: значения от 0 до 1 переводятся в целый VisibleCharacters с усечением. Значение от 1 показывает всё, отрицательное скрывает. Не создаёт таймер: увеличивайте долю из анимации приложения. Доля относится к счётчику содержимого, не обязательно к числу визуально отдельных букв.
Методы163
AddHrvoid
public void AddHr(int width = 90, int height = 2, Color? color = default, HorizontalAlignment alignment = HorizontalAlignment.Center, bool widthInPercent = true, bool heightInPercent = false);Добавляет горизонтальный разделитель как отдельное содержимое абзаца. По умолчанию ширина 90% доступной ширины текста и высота 2 пикселя. При процентной высоте она тоже считается от ширины, не высоты метки. Собственная область абзаца закрывается внутри команды: дополнительный Pop не нужен.
| Имя | Тип | По умолчанию |
|---|---|---|
width | int | 90 |
height | int | 2 |
color | Color? | default |
alignment | HorizontalAlignment | HorizontalAlignment.Center |
widthInPercent | bool | true |
heightInPercent | bool | false |
widthНеотрицательная ширина; по умолчанию 90 процентов.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
alignmentГоризонтальное выравнивание разделителя.
widthInPercentВыбирать проценты вместо пикселей по ширине.
heightInPercentВыбирать проценты вместо пикселей по высоте; база процентов — ширина текста.
AddImage5 перегрузок
public void AddImage(Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region);Добавляет встроенное изображение из действительной Texture2D с ненулевыми размерами. Нулевые width/height используют естественный размер; одна заданная сторона сохраняет пропорции. Pixel — пиксели, Percent — проценты доступной ширины текста для обеих осей, Em — множитель текущего размера шрифта (1 означает один em). Для последующего обновления задайте уникальный key. Это содержимое, не Push-область: дополнительный Pop не нужен. В таблице сначала откройте ячейку.
| Имя | Тип | По умолчанию |
|---|---|---|
image | Texture2D | — |
width | int | — |
height | int | — |
color | Color? | — |
inlineAlign | InlineAlignment | — |
region | Rect2? | — |
imageДействительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.
widthНеотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
regionОбласть текстуры в пикселях; пустой Rect2 использует всю текстуру.
public void AddImage(Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region, Variant key, bool pad, string tooltip, bool sizeInPercent);Добавляет встроенное изображение из действительной Texture2D с ненулевыми размерами. Нулевые width/height используют естественный размер; одна заданная сторона сохраняет пропорции. Pixel — пиксели, Percent — проценты доступной ширины текста для обеих осей, Em — множитель текущего размера шрифта (1 означает один em). Для последующего обновления задайте уникальный key. Это содержимое, не Push-область: дополнительный Pop не нужен. В таблице сначала откройте ячейку.
| Имя | Тип | По умолчанию |
|---|---|---|
image | Texture2D | — |
width | int | — |
height | int | — |
color | Color? | — |
inlineAlign | InlineAlignment | — |
region | Rect2? | — |
key | Variant | — |
pad | bool | — |
tooltip | string | — |
sizeInPercent | bool | — |
imageДействительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.
widthНеотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
regionОбласть текстуры в пикселях; пустой Rect2 использует всю текстуру.
keyУникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.
padЦентрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.
tooltipТекст подсказки изображения.
sizeInPercentВ старой перегрузке true выбирает проценты для обеих осей.
public void AddImage(Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region, Variant key, bool pad, string tooltip, bool widthInPercent, bool heightInPercent, string altText);Добавляет встроенное изображение из действительной Texture2D с ненулевыми размерами. Нулевые width/height используют естественный размер; одна заданная сторона сохраняет пропорции. Pixel — пиксели, Percent — проценты доступной ширины текста для обеих осей, Em — множитель текущего размера шрифта (1 означает один em). Для последующего обновления задайте уникальный key. Это содержимое, не Push-область: дополнительный Pop не нужен. В таблице сначала откройте ячейку.
| Имя | Тип | По умолчанию |
|---|---|---|
image | Texture2D | — |
width | int | — |
height | int | — |
color | Color? | — |
inlineAlign | InlineAlignment | — |
region | Rect2? | — |
key | Variant | — |
pad | bool | — |
tooltip | string | — |
widthInPercent | bool | — |
heightInPercent | bool | — |
altText | string | — |
imageДействительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.
widthНеотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
regionОбласть текстуры в пикселях; пустой Rect2 использует всю текстуру.
keyУникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.
padЦентрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.
tooltipТекст подсказки изображения.
widthInPercentВыбирать проценты вместо пикселей по ширине.
heightInPercentВыбирать проценты вместо пикселей по высоте; база процентов — ширина текста.
altTextОписание изображения для вспомогательных технологий, не видимая подпись.
public void AddImage(Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region, Variant key, bool pad, string tooltip, bool sizeInPercent, string altText);Добавляет встроенное изображение из действительной Texture2D с ненулевыми размерами. Нулевые width/height используют естественный размер; одна заданная сторона сохраняет пропорции. Pixel — пиксели, Percent — проценты доступной ширины текста для обеих осей, Em — множитель текущего размера шрифта (1 означает один em). Для последующего обновления задайте уникальный key. Это содержимое, не Push-область: дополнительный Pop не нужен. В таблице сначала откройте ячейку.
| Имя | Тип | По умолчанию |
|---|---|---|
image | Texture2D | — |
width | int | — |
height | int | — |
color | Color? | — |
inlineAlign | InlineAlignment | — |
region | Rect2? | — |
key | Variant | — |
pad | bool | — |
tooltip | string | — |
sizeInPercent | bool | — |
altText | string | — |
imageДействительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.
widthНеотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
regionОбласть текстуры в пикселях; пустой Rect2 использует всю текстуру.
keyУникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.
padЦентрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.
tooltipТекст подсказки изображения.
sizeInPercentВ старой перегрузке true выбирает проценты для обеих осей.
altTextОписание изображения для вспомогательных технологий, не видимая подпись.
public void AddImage(Texture2D image, float width = 0f, float height = 0f, Color? color = default, InlineAlignment inlineAlign = InlineAlignment.Center, Rect2? region = default, Variant key = default, bool pad = false, string tooltip = "", RichTextLabel.ImageUnit widthUnit = RichTextLabel.ImageUnit.Pixel, RichTextLabel.ImageUnit heightUnit = RichTextLabel.ImageUnit.Pixel, string altText = "");Добавляет встроенное изображение из действительной Texture2D с ненулевыми размерами. Нулевые width/height используют естественный размер; одна заданная сторона сохраняет пропорции. Pixel — пиксели, Percent — проценты доступной ширины текста для обеих осей, Em — множитель текущего размера шрифта (1 означает один em). Для последующего обновления задайте уникальный key. Это содержимое, не Push-область: дополнительный Pop не нужен. В таблице сначала откройте ячейку.
| Имя | Тип | По умолчанию |
|---|---|---|
image | Texture2D | — |
width | float | 0f |
height | float | 0f |
color | Color? | default |
inlineAlign | InlineAlignment | InlineAlignment.Center |
region | Rect2? | default |
key | Variant | default |
pad | bool | false |
tooltip | string | "" |
widthUnit | RichTextLabel.ImageUnit | RichTextLabel.ImageUnit.Pixel |
heightUnit | RichTextLabel.ImageUnit | RichTextLabel.ImageUnit.Pixel |
altText | string | "" |
imageДействительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.
widthНеотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
regionОбласть текстуры в пикселях; пустой Rect2 использует всю текстуру.
keyУникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.
padЦентрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.
tooltipТекст подсказки изображения.
widthUnitPixel, Percent или Em для ширины; в UpdateImage применяется через маску WidthUnit.
heightUnitЕдиницы высоты; Percent использует ширину области, Em умножает размер шрифта.
altTextОписание изображения для вспомогательных технологий, не видимая подпись.
AddTextvoid
public void AddText(string text);Добавляет буквальный текст в текущую область форматирования. Теги в квадратных скобках не разбираются. Подходит для пользовательского текста внутри Push/Pop без интерпретации его как разметки. Не обновляет свойство Text; прямо внутрь таблицы текст не добавляется — нужна ячейка.
| Имя | Тип | По умолчанию |
|---|---|---|
text | string | — |
textИсходный или буквальный текст в зависимости от метода; AddText не разбирает теги.
AppendTextvoid
public void AppendText(string bbcode);Разбирает фрагмент BBCode и добавляет форматированное содержимое без полного сброса. Не дописывает фрагмент в свойство Text. Для данных, которые должны отображаться буквально, используйте AddText. Держите пары тегов согласованными; для программных областей удобнее Push/Pop.
| Имя | Тип | По умолчанию |
|---|---|---|
bbcode | string | — |
bbcodeФрагмент BBCode для разбора, не буквальный текст.
Clearvoid
public void Clear();Удаляет построенное содержимое и области форматирования, сбрасывает выделение и эффекты текущего текста. Сохранённая исходная строка Text остаётся; для её очистки назначьте Text = "". Не очищает список зарегистрированных CustomEffects.
Deselectvoid
public void Deselect();Снимает текущее выделение без изменения текста, прокрутки или разрешения SelectionEnabled.
GetAutowrapModeTextServer.AutowrapMode
public TextServer.AutowrapMode GetAutowrapMode();Правило переноса по доступной ширине: отключение, произвольный перенос или перенос по словам. Меняет визуальные строки и размеры, сохраняя исходный Text. Для предсказуемого результата задайте метке ширину через компоновку.
TextServer.AutowrapModeПравило переноса по доступной ширине: отключение, произвольный перенос или перенос по словам. Меняет визуальные строки и размеры, сохраняя исходный Text. Для предсказуемого результата задайте метке ширину через компоновку.
GetAutowrapTrimFlagsTextServer.LineBreakFlag
public TextServer.LineBreakFlag GetAutowrapTrimFlags();Флаги обработки краевых пробелов и отступа при переносе. Setter сохраняет только биты trim-маски TextServer; другие LineBreakFlag не включают здесь собственный режим переноса. Исходный текст не обрезается.
TextServer.LineBreakFlagФлаги обработки краевых пробелов и отступа при переносе. Setter сохраняет только биты trim-маски TextServer; другие LineBreakFlag не включают здесь собственный режим переноса. Исходный текст не обрезается.
GetCharacterLineint
public int GetCharacterLine(int character);Возвращает индекс визуальной строки переноса, содержащей позицию содержимого, либо -1, если она не найдена среди рассчитанных данных. Индекс символа не является смещением в исходном BBCode или UTF-16. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
| Имя | Тип | По умолчанию |
|---|---|---|
character | int | — |
characterПозиция в содержимом без тегов, не UTF-16-индекс исходного Text.
intВозвращает индекс визуальной строки переноса, содержащей позицию содержимого, либо -1, если она не найдена среди рассчитанных данных. Индекс символа не является смещением в исходном BBCode или UTF-16. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
GetCharacterParagraphint
public int GetCharacterParagraph(int character);Возвращает индекс абзаца для позиции содержимого либо -1. Абзац может содержать несколько строк переноса. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
| Имя | Тип | По умолчанию |
|---|---|---|
character | int | — |
characterПозиция в содержимом без тегов, не UTF-16-индекс исходного Text.
intВозвращает индекс абзаца для позиции содержимого либо -1. Абзац может содержать несколько строк переноса. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
GetContentHeightint
public int GetContentHeight();Высота рассчитанного содержимого в пикселях с интервалами темы. Это не высота видимого окна прокрутки. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
intВысота рассчитанного содержимого в пикселях с интервалами темы. Это не высота видимого окна прокрутки. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
GetContentWidthint
public int GetContentWidth();Ширина рассчитанного содержимого в пикселях элемента, а не ограничение размера Control. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
intШирина рассчитанного содержимого в пикселях элемента, а не ограничение размера Control. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
GetEffectsReckfell.Collections.Array
public Reckfell.Collections.Array GetEffects();Ресурсы пользовательских BBCode-эффектов. Setter заменяет массив и вызывает ReloadEffects; getter разделяет массив, поэтому изменение результата само по себе не перезапускает разбор. Эффекты с совпадающими именами неоднозначны: используется первое подходящее имя. Для прямого программного применения используйте PushCustomfx.
Reckfell.Collections.ArrayРесурсы пользовательских BBCode-эффектов. Setter заменяет массив и вызывает ReloadEffects; getter разделяет массив, поэтому изменение результата само по себе не перезапускает разбор. Эффекты с совпадающими именами неоднозначны: используется первое подходящее имя. Для прямого программного применения используйте PushCustomfx.
GetHorizontalAlignmentHorizontalAlignment
public HorizontalAlignment GetHorizontalAlignment();Выравнивание основного текста по горизонтали; локальная разметка абзаца может задавать своё. Fill использует JustificationFlags для выравнивания по ширине. Не перемещает сам Control в родительском контейнере.
HorizontalAlignmentВыравнивание основного текста по горизонтали; локальная разметка абзаца может задавать своё. Fill использует JustificationFlags для выравнивания по ширине. Не перемещает сам Control в родительском контейнере.
GetJustificationFlagsTextServer.JustificationFlag
public TextServer.JustificationFlag GetJustificationFlags();Правила растяжения строк при выравнивании по ширине, например обработка слов и последней строки. Действуют вместе с соответствующим выравниванием; не задают ширину метки.
TextServer.JustificationFlagПравила растяжения строк при выравнивании по ширине, например обработка слов и последней строки. Действуют вместе с соответствующим выравниванием; не задают ширину метки.
GetLanguagestring
public string GetLanguage();Языковая подсказка текстовой системе для формирования и переноса. Не переводит строку на другой язык; перевод UI исходного Text — отдельный механизм.
stringЯзыковая подсказка текстовой системе для формирования и переноса. Не переводит строку на другой язык; перевод UI исходного Text — отдельный механизм.
GetLineCountint
public int GetLineCount();Число рассчитанных визуальных строк основного потока, включая переносы. В отличие от TextEdit это не число логических строк файла. Зависит от ширины, шрифта и режима показа. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
intЧисло рассчитанных визуальных строк основного потока, включая переносы. В отличие от TextEdit это не число логических строк файла. Зависит от ширины, шрифта и режима показа. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
GetLineHeightint
public int GetLineHeight(int line);Высота визуальной строки: ascent + descent + интервал строк темы. Может отличаться между строками из-за форматирования. Передавайте существующий индекс. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
lineИндекс визуальной строки переноса от 0.
intВысота визуальной строки: ascent + descent + интервал строк темы. Может отличаться между строками из-за форматирования. Передавайте существующий индекс. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
GetLineOffsetfloat
public float GetLineOffset(int line);Вертикальное смещение визуальной строки в содержимом, в пикселях. Это не глобальная позиция экрана и не готовая координата после вычитания прокрутки. Проверяйте индекс заранее: 0 также может быть корректным смещением первой строки.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
lineИндекс визуальной строки переноса от 0.
floatВертикальное смещение визуальной строки в содержимом, в пикселях. Это не глобальная позиция экрана и не готовая координата после вычитания прокрутки. Проверяйте индекс заранее: 0 также может быть корректным смещением первой строки.
GetLineRangeVector2I
public Vector2I GetLineRange(int line);Диапазон позиций содержимого для рассчитанной визуальной строки: X — начало, Y — конец. Не диапазон исходной BBCode-строки или индексов UTF-16. Сначала проверьте 0 <= line < GetLineCount; (0, 0) не является надёжным признаком ошибки. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
lineИндекс визуальной строки переноса от 0.
Vector2IДиапазон позиций содержимого для рассчитанной визуальной строки: X — начало, Y — конец. Не диапазон исходной BBCode-строки или индексов UTF-16. Сначала проверьте 0 <= line < GetLineCount; (0, 0) не является надёжным признаком ошибки. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
GetLineWidthint
public int GetLineWidth(int line);Ширина существующей рассчитанной визуальной строки в пикселях. Передавайте индекс от 0 до GetLineCount() - 1, не номер абзаца. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
lineИндекс визуальной строки переноса от 0.
intШирина существующей рассчитанной визуальной строки в пикселях. Передавайте индекс от 0 до GetLineCount() - 1, не номер абзаца. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.
GetMaximumFontSizeint
public int GetMaximumFontSize();Верхняя граница подбора при ResizeFontToFit. Согласуйте с MinimumFontSize; это ограничение подбора, а не общий запрет локальных размеров BBCode.
intВерхняя граница подбора при ResizeFontToFit. Согласуйте с MinimumFontSize; это ограничение подбора, а не общий запрет локальных размеров BBCode.
GetMenuPopupMenu
public PopupMenu GetMenu();Возвращает встроенный PopupMenu, создавая его при первом обращении без показа. Меню принадлежит метке и удаляется вместе с ней; не вызывайте Free/Dispose для этой заимствованной ссылки.
PopupMenuВозвращает встроенный PopupMenu, создавая его при первом обращении без показа. Меню принадлежит метке и удаляется вместе с ней; не вызывайте Free/Dispose для этой заимствованной ссылки.
GetMinimumFontSizeint
public int GetMinimumFontSize();Нижняя граница подбора при ResizeFontToFit. Задавайте положительное значение не больше MaximumFontSize. Само назначение не означает, что именно этот размер уже нарисован.
intНижняя граница подбора при ResizeFontToFit. Задавайте положительное значение не больше MaximumFontSize. Само назначение не означает, что именно этот размер уже нарисован.
GetParagraphCountint
public int GetParagraphCount();Количество абзацев основного потока содержимого. Автоматические переносы внутри абзаца не создают новый абзац. Не используйте это число как число всех визуальных строк или ячеек вложенных таблиц.
intКоличество абзацев основного потока содержимого. Автоматические переносы внутри абзаца не создают новый абзац. Не используйте это число как число всех визуальных строк или ячеек вложенных таблиц.
GetParagraphOffsetfloat
public float GetParagraphOffset(int paragraph);Вертикальное смещение рассчитанного абзаца в пикселях содержимого. Проверяйте индекс и готовность; 0 может означать как начало, так и отсутствие рассчитанного результата.
| Имя | Тип | По умолчанию |
|---|---|---|
paragraph | int | — |
paragraphИндекс абзаца основного потока от 0.
floatВертикальное смещение рассчитанного абзаца в пикселях содержимого. Проверяйте индекс и готовность; 0 может означать как начало, так и отсутствие рассчитанного результата.
GetParsedTextstring
public string GetParsedText();Возвращает обычный текст построенного содержимого без тегов. Встроенные изображения представлены пробелами, списки/отступы могут добавлять tab. Это не обратное преобразование в исходный BBCode и не копия свойства Text.
stringВозвращает обычный текст построенного содержимого без тегов. Встроенные изображения представлены пробелами, списки/отступы могут добавлять tab. Это не обратное преобразование в исходный BBCode и не копия свойства Text.
GetProgressBarDelayint
public int GetProgressBarDelay();Задержка показа индикатора фоновой загрузки в миллисекундах. Положительное значение ждёт этот интервал; 0 и отрицательные значения отключают индикатор. Не задаёт скорость разбора или задержку появления символов.
intЗадержка показа индикатора фоновой загрузки в миллисекундах. Положительное значение ждёт этот интервал; 0 и отрицательные значения отключают индикатор. Не задаёт скорость разбора или задержку появления символов.
GetRenderedFontSizeint
public int GetRenderedFontSize();Текущее вычисленное значение подбора основного шрифта. Не описывает каждый локально форматированный фрагмент. При отключении подбора кэш сбрасывается в 0; не используйте 0 как реальный размер для создания другого шрифта.
intТекущее вычисленное значение подбора основного шрифта. Не описывает каждый локально форматированный фрагмент. При отключении подбора кэш сбрасывается в 0; не используйте 0 как реальный размер для создания другого шрифта.
GetSelectedTextstring
public string GetSelectedText();Возвращает выделенный обычный текст без тегов, либо пустую строку при отсутствии/запрете выделения. Встроенные изображения представлены пробелами; таблицы обходятся как содержимое. Это не срез исходного Text с BBCode.
stringВозвращает выделенный обычный текст без тегов, либо пустую строку при отсутствии/запрете выделения. Встроенные изображения представлены пробелами; таблицы обходятся как содержимое. Это не срез исходного Text с BBCode.
GetSelectionFromint
public int GetSelectionFrom();Возвращает начальную позицию активного выделения в модели содержимого или -1. Не является индексом в исходной BBCode-строке или UTF-16; для получения текста используйте GetSelectedText, особенно при таблицах и встроенных объектах.
intВозвращает начальную позицию активного выделения в модели содержимого или -1. Не является индексом в исходной BBCode-строке или UTF-16; для получения текста используйте GetSelectedText, особенно при таблицах и встроенных объектах.
GetSelectionLineOffsetfloat
public float GetSelectionLineOffset();Вертикальное смещение начала выделения в пикселях содержимого с учётом переноса и вложенных рамок. -1 означает отсутствие подходящего выделения. Это не номер строки и не глобальная координата экрана.
floatВертикальное смещение начала выделения в пикселях содержимого с учётом переноса и вложенных рамок. -1 означает отсутствие подходящего выделения. Это не номер строки и не глобальная координата экрана.
GetSelectionToint
public int GetSelectionTo();Возвращает включённую конечную позицию активного выделения или -1. Для обычного диапазона содержимого длина равна to - from + 1; это не исключённая граница TextEdit. Не используйте напрямую как индекс среза исходной строки C#.
intВозвращает включённую конечную позицию активного выделения или -1. Для обычного диапазона содержимого длина равна to - from + 1; это не исключённая граница TextEdit. Не используйте напрямую как индекс среза исходной строки C#.
GetStructuredTextBidiOverrideTextServer.StructuredTextParser
public TextServer.StructuredTextParser GetStructuredTextBidiOverride();Выбирает разбор структурированного двунаправленного текста, например адресов и путей. Это настройка формирования, не regex-замена исходной строки. Параметры задаёт StructuredTextBidiOverrideOptions.
TextServer.StructuredTextParserВыбирает разбор структурированного двунаправленного текста, например адресов и путей. Это настройка формирования, не regex-замена исходной строки. Параметры задаёт StructuredTextBidiOverrideOptions.
GetStructuredTextBidiOverrideOptionsReckfell.Collections.Array
public Reckfell.Collections.Array GetStructuredTextBidiOverrideOptions();Параметры структурированного BiDi-разбора. Массив сохраняется по общей ссылке; изменение его содержимого не запускает перерасчёт автоматически. Для обновления назначьте новый массив с отличающимся содержимым: равное содержимое setter может пропустить.
Reckfell.Collections.ArrayПараметры структурированного BiDi-разбора. Массив сохраняется по общей ссылке; изменение его содержимого не запускает перерасчёт автоматически. Для обновления назначьте новый массив с отличающимся содержимым: равное содержимое setter может пропустить.
GetTabSizeint
public int GetTabSize();Ширина стандартного шага табуляции в пробелах; используйте положительное значение. Меняет отображение tab, не заменяет его пробелами в Text. Для явных позиций используйте TabStops.
intШирина стандартного шага табуляции в пробелах; используйте положительное значение. Меняет отображение tab, не заменяет его пробелами в Text. Для явных позиций используйте TabStops.
GetTabStopsfloat[]
public float[] GetTabStops();Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.
float[]Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.
GetTextstring
public string GetText();Исходная строка для полного построения метки, с переводом UI и разбором BBCode при включённом BbcodeEnabled. Назначение заменяет ручное содержимое; одинаковая непустая строка может ничего не перестроить. AddText, AppendText и Push-методы не дописывают сюда свой результат. Для получившегося обычного текста используйте GetParsedText.
stringИсходная строка для полного построения метки, с переводом UI и разбором BBCode при включённом BbcodeEnabled. Назначение заменяет ручное содержимое; одинаковая непустая строка может ничего не перестроить. AddText, AppendText и Push-методы не дописывают сюда свой результат. Для получившегося обычного текста используйте GetParsedText.
GetTextDirectionControl.TextDirection
public Control.TextDirection GetTextDirection();Направление текста для BiDi-формирования. Не переставляет символы исходной строки вручную и не переводит текст. Разметка структурированного текста настраивается отдельно.
Control.TextDirectionНаправление текста для BiDi-формирования. Не переставляет символы исходной строки вручную и не переводит текст. Разметка структурированного текста настраивается отдельно.
GetTotalCharacterCountint
public int GetTotalCharacterCount();Считает содержимое без BBCode-тегов: текстовые кодовые точки, переводы строк и по одной позиции на встроенное изображение. Это не Text.Length, не число глифов и не количество уже видимых букв. Используйте как предел раскрытия, а не индекс среза исходной BBCode-строки.
intСчитает содержимое без BBCode-тегов: текстовые кодовые точки, переводы строк и по одной позиции на встроенное изображение. Это не Text.Length, не число глифов и не количество уже видимых букв. Используйте как предел раскрытия, а не индекс среза исходной BBCode-строки.
GetVScrollBarVScrollBar
public VScrollBar GetVScrollBar();Возвращает встроенный VScrollBar, принадлежащий метке. Не освобождайте его через Free/Dispose и не переподчиняйте другому родителю. Значение измеряется в пикселях содержимого; доступный диапазон учитывает страницу полосы.
VScrollBarВозвращает встроенный VScrollBar, принадлежащий метке. Не освобождайте его через Free/Dispose и не переподчиняйте другому родителю. Значение измеряется в пикселях содержимого; доступный диапазон учитывает страницу полосы.
GetVerticalAlignmentVerticalAlignment
public VerticalAlignment GetVerticalAlignment();Размещение текстового содержимого по вертикали внутри области метки. Не меняет вертикальное выравнивание Control у родителя и не включает автоматическую прокрутку.
VerticalAlignmentРазмещение текстового содержимого по вертикали внутри области метки. Не меняет вертикальное выравнивание Control у родителя и не включает автоматическую прокрутку.
GetVisibleCharactersint
public int GetVisibleCharacters();Лимит постепенного показа: -1 показывает всё, 0 скрывает текст, неотрицательное значение задаёт предел. Поведение до/после формирования глифов выбирает VisibleCharactersBehavior. Это не количество кадров и не UTF-16 Length строки Text. Setter пересчитывает VisibleRatio, но не ограничивает явно слишком большое значение; для анимации держите диапазон от 0 до GetTotalCharacterCount.
intЛимит постепенного показа: -1 показывает всё, 0 скрывает текст, неотрицательное значение задаёт предел. Поведение до/после формирования глифов выбирает VisibleCharactersBehavior. Это не количество кадров и не UTF-16 Length строки Text. Setter пересчитывает VisibleRatio, но не ограничивает явно слишком большое значение; для анимации держите диапазон от 0 до GetTotalCharacterCount.
GetVisibleCharactersBehaviorTextServer.VisibleCharactersBehavior
public TextServer.VisibleCharactersBehavior GetVisibleCharactersBehavior();Определяет, применяется ли лимит до формирования текста или к уже сформированным символам/глифам. До формирования может меняться раскладка; после формирования сохраняется контекст полной строки, но единицы показа зависят от режима. Учитывайте лигатуры, составные символы и RTL; не предполагайте один char C# на один видимый глиф.
TextServer.VisibleCharactersBehaviorОпределяет, применяется ли лимит до формирования текста или к уже сформированным символам/глифам. До формирования может меняться раскладка; после формирования сохраняется контекст полной строки, но единицы показа зависят от режима. Учитывайте лигатуры, составные символы и RTL; не предполагайте один char C# на один видимый глиф.
GetVisibleContentRectRect2I
public Rect2I GetVisibleContentRect();Кэшированный прямоугольник нарисованного видимого содержимого в координатах метки. Не размер всего текста и не экранный прямоугольник. До актуальной отрисовки может быть пустым или относиться к прежнему кадру; один IsFinished не обновляет этот кэш.
Rect2IКэшированный прямоугольник нарисованного видимого содержимого в координатах метки. Не размер всего текста и не экранный прямоугольник. До актуальной отрисовки может быть пустым или относиться к прежнему кадру; один IsFinished не обновляет этот кэш.
GetVisibleLineCountint
public int GetVisibleLineCount();Число видимых строк из результатов отрисовки. Это не вместимость окна по высоте и не общее GetLineCount. При Visible = false возвращает 0; сразу после изменения текста или размера дождитесь актуального кадра. IsFinished подтверждает расчёт, но не наличие нового кадра.
intЧисло видимых строк из результатов отрисовки. Это не вместимость окна по высоте и не общее GetLineCount. При Visible = false возвращает 0; сразу после изменения текста или размера дождитесь актуального кадра. IsFinished подтверждает расчёт, но не наличие нового кадра.
GetVisibleParagraphCountint
public int GetVisibleParagraphCount();Число видимых абзацев по результатам отрисовки, не число строк переноса. Для актуального результата нужен кадр после изменения содержимого/прокрутки; при Visible = false возвращает 0.
intЧисло видимых абзацев по результатам отрисовки, не число строк переноса. Для актуального результата нужен кадр после изменения содержимого/прокрутки; при Visible = false возвращает 0.
GetVisibleRatiofloat
public float GetVisibleRatio();Доля показа: значения от 0 до 1 переводятся в целый VisibleCharacters с усечением. Значение от 1 показывает всё, отрицательное скрывает. Не создаёт таймер: увеличивайте долю из анимации приложения. Доля относится к счётчику содержимого, не обязательно к числу визуально отдельных букв.
floatДоля показа: значения от 0 до 1 переводятся в целый VisibleCharacters с усечением. Значение от 1 показывает всё, отрицательное скрывает. Не создаёт таймер: увеличивайте долю из анимации приложения. Доля относится к счётчику содержимого, не обязательно к числу визуально отдельных букв.
InstallEffectvoid
public void InstallEffect(Variant effect);Добавляет ресурс RichTextEffect к зарегистрированным эффектам и вызывает ReloadEffects. Не заменяет автоматически существующий ресурс с тем же именем тега. Имя BBCode определяется скриптом эффекта; для обхода поиска имени применяйте PushCustomfx.
| Имя | Тип | По умолчанию |
|---|---|---|
effect | Variant | — |
effectДействительный ресурс RichTextEffect.
InvalidateParagraphbool
public bool InvalidateParagraph(int paragraph);Помечает расчёт формы, размера и шрифта начиная с указанного абзаца как устаревший. Не удаляет абзац, не меняет Text и не выполняет полный разбор BBCode. true означает принятый индекс, а не завершение пересчёта; проверяйте IsFinished отдельно.
| Имя | Тип | По умолчанию |
|---|---|---|
paragraph | int | — |
paragraphИндекс абзаца основного потока от 0 до GetParagraphCount() - 1.
boolПомечает расчёт формы, размера и шрифта начиная с указанного абзаца как устаревший. Не удаляет абзац, не меняет Text и не выполняет полный разбор BBCode. true означает принятый индекс, а не завершение пересчёта; проверяйте IsFinished отдельно.
IsContextMenuEnabledbool
public bool IsContextMenuEnabled();Разрешает открытие встроенного пользовательского меню. false не удаляет PopupMenu и не запрещает программные GetMenu/MenuOption. Это настройка интерфейса, а не запрет копирования данных приложением.
boolРазрешает открытие встроенного пользовательского меню. false не удаляет PopupMenu и не запрещает программные GetMenu/MenuOption. Это настройка интерфейса, а не запрет копирования данных приложением.
IsDeselectOnFocusLossEnabledbool
public bool IsDeselectOnFocusLossEnabled();Разрешает снятие выделения при потере фокуса. При переключении false → true у метки без фокуса существующее выделение снимается сразу. Для сохранения выделения при переходе к другому элементу используйте false.
boolРазрешает снятие выделения при потере фокуса. При переключении false → true у метки без фокуса существующее выделение снимается сразу. Для сохранения выделения при переходе к другому элементу используйте false.
IsDragAndDropSelectionEnabledbool
public bool IsDragAndDropSelectionEnabled();Разрешает пользовательское перетаскивание выделенного обычного текста из метки. Нужно SelectionEnabled; не включает редактирование или приём произвольных файлов. Назначение свойства не запускает перенос.
boolРазрешает пользовательское перетаскивание выделенного обычного текста из метки. Нужно SelectionEnabled; не включает редактирование или приём произвольных файлов. Назначение свойства не запускает перенос.
IsFinishedbool
public bool IsFinished();Проверяет завершённость текущих расчётов формы, размера и шрифтов. Проверка сама может запустить обновление кэшей; это не ожидание блокировкой и не признак завершения анимации VisibleCharacters. Подписываясь на Finished, учитывайте, что текст уже мог быть готов.
boolПроверяет завершённость текущих расчётов формы, размера и шрифтов. Проверка сама может запустить обновление кэшей; это не ожидание блокировкой и не признак завершения анимации VisibleCharacters. Подписываясь на Finished, учитывайте, что текст уже мог быть готов.
IsFitContentEnabledbool
public bool IsFitContentEnabled();Учитывает содержимое в минимальном размере метки. Родительский контейнер может расширить элемент; это не команда установить точный Size и не уменьшение шрифта. Учитывайте взаимодействие с переносами и ограничениями родителя.
boolУчитывает содержимое в минимальном размере метки. Родительский контейнер может расширить элемент; это не команда установить точный Size и не уменьшение шрифта. Учитывайте взаимодействие с переносами и ограничениями родителя.
IsHintUnderlinedbool
public bool IsHintUnderlined();Разрешает визуальное подчёркивание областей PushHint. Не включает или отключает само содержимое подсказки и не меняет текст.
boolРазрешает визуальное подчёркивание областей PushHint. Не включает или отключает само содержимое подсказки и не меняет текст.
IsMenuVisiblebool
public bool IsMenuVisible();Проверяет фактическую видимость уже созданного меню, не создавая его. false до создания не означает, что ContextMenuEnabled выключен.
boolПроверяет фактическую видимость уже созданного меню, не создавая его. false до создания не означает, что ContextMenuEnabled выключен.
IsMetaUnderlinedbool
public bool IsMetaUnderlined();Разрешает подчёркивание областей метаданных с учётом их MetaUnderline. Не создаёт ссылку и не открывает URL. Явная область PushUnderline остаётся отдельным форматированием.
boolРазрешает подчёркивание областей метаданных с учётом их MetaUnderline. Не создаёт ссылку и не открывает URL. Явная область PushUnderline остаётся отдельным форматированием.
IsReadybool · Устарело
public bool IsReady();Устаревший псевдоним IsFinished. Используйте IsFinished; это готовность раскладки, не готовность сущности к работе и не сигнал входа в дерево.
boolУстаревший псевдоним IsFinished. Используйте IsFinished; это готовность раскладки, не готовность сущности к работе и не сигнал входа в дерево.
IsResizeFontToFitEnabledbool
public bool IsResizeFontToFitEnabled();Разрешает подбирать размер основного шрифта для доступной области в диапазоне MinimumFontSize–MaximumFontSize. Не заменяет FitContent: здесь меняется шрифт, а не требование минимального размера. Подбор зависит от ширины и высоты; слишком маленький минимум не гарантирует читаемость.
boolРазрешает подбирать размер основного шрифта для доступной области в диапазоне MinimumFontSize–MaximumFontSize. Не заменяет FitContent: здесь меняется шрифт, а не требование минимального размера. Подбор зависит от ширины и высоты; слишком маленький минимум не гарантирует читаемость.
IsScrollActivebool
public bool IsScrollActive();Разрешает встроенную вертикальную прокрутку. Переключение вызывает повторное применение исходного Text: при смешении с ручным AddText/Push содержимое может быть перестроено из сохранённой строки. Задавайте режим до ручного построения. Не означает, что всё содержимое помещается без полосы.
boolРазрешает встроенную вертикальную прокрутку. Переключение вызывает повторное применение исходного Text: при смешении с ручным AddText/Push содержимое может быть перестроено из сохранённой строки. Задавайте режим до ручного построения. Не означает, что всё содержимое помещается без полосы.
IsScrollFollowingbool
public bool IsScrollFollowing();Разрешает следование за концом дополняемого текста. Если пользователь прокрутил вверх, фактическое следование может приостановиться до возвращения к низу. Getter сообщает настройку, а не факт положения внизу.
boolРазрешает следование за концом дополняемого текста. Если пользователь прокрутил вверх, фактическое следование может приостановиться до возвращения к низу. Getter сообщает настройку, а не факт положения внизу.
IsScrollFollowingVisibleCharactersbool
public bool IsScrollFollowingVisibleCharacters();Прокручивает к области, раскрываемой через VisibleCharacters. Отличается от следования за полным концом текста: предназначено для постепенного показа. Назначение true может сразу изменить прокрутку.
boolПрокручивает к области, раскрываемой через VisibleCharacters. Отличается от следования за полным концом текста: предназначено для постепенного показа. Назначение true может сразу изменить прокрутку.
IsSelectionEnabledbool
public bool IsSelectionEnabled();Разрешает выделение отображаемого текста и SelectAll. Включение задаёт FocusMode.All; отключение снимает активное выделение и устанавливает режим фокуса доступности. Не делает метку редактируемой и не изменяет Text.
boolРазрешает выделение отображаемого текста и SelectAll. Включение задаёт FocusMode.All; отключение снимает активное выделение и устанавливает режим фокуса доступности. Не делает метку редактируемой и не изменяет Text.
IsShortcutKeysEnabledbool
public bool IsShortcutKeysEnabled();Разрешает встроенные сочетания команд метки. Не включает SelectionEnabled автоматически и не запрещает прямые программные вызовы SelectAll/MenuOption.
boolРазрешает встроенные сочетания команд метки. Не включает SelectionEnabled автоматически и не запрещает прямые программные вызовы SelectAll/MenuOption.
IsThreadedbool
public bool IsThreaded();Разрешает фоновый расчёт раскладки текста; по умолчанию false. Не делает произвольные вызовы RichTextLabel потокобезопасными и не переносит всю отрисовку в другой поток. Следите за IsFinished; до завершения метрики могут описывать только обработанную часть.
boolРазрешает фоновый расчёт раскладки текста; по умолчанию false. Не делает произвольные вызовы RichTextLabel потокобезопасными и не переносит всю отрисовку в другой поток. Следите за IsFinished; до завершения метрики могут описывать только обработанную часть.
IsUsingBbcodebool
public bool IsUsingBbcode();Определяет разбор свойства Text как BBCode. Для ручного AddText разбор не включается; AppendText самостоятельно разбирает разметку. Переключение настройки не гарантирует перестройку вручную изменённого стека.
boolОпределяет разбор свойства Text как BBCode. Для ручного AddText разбор не включается; AppendText самостоятельно разбирает разметку. Переключение настройки не гарантирует перестройку вручную изменённого стека.
MenuOptionvoid
public void MenuOption(int option);Выполняет команду по ID MenuItems как int, не по индексу строки меню. Copy копирует выделение, а при пустом выделении — весь GetParsedText, даже если SelectionEnabled выключен. SelectAll требует разрешённого выделения. Не открывает меню; ContextMenuEnabled не блокирует прямой вызов.
| Имя | Тип | По умолчанию |
|---|---|---|
option | int | — |
optionЧисловой ID команды MenuItems, не индекс PopupMenu.
Newlinevoid
public void Newline();Добавляет явный перевод строки в текущее построенное содержимое и начинает следующий абзац текущей рамки. Не обновляет исходное свойство Text; не является автоматическим переносом по ширине.
ParseBbcodevoid
public void ParseBbcode(string bbcode);Очищает текущее отображаемое содержимое и разбирает переданную разметку. Это полный разбор вместо дополнения AppendText. Не присваивает свойство Text; для хранения исходной строки назначайте Text при включённом BbcodeEnabled.
| Имя | Тип | По умолчанию |
|---|---|---|
bbcode | string | — |
bbcodeФрагмент BBCode для разбора, не буквальный текст.
ParseExpressionsForValues2 перегрузки
public Reckfell.Collections.Dictionary ParseExpressionsForValues(ReadOnlySpan<string> expressions);Разбирает параметры вида key=value, не выполняя код или математические выражения. Распознаёт точные true/false, числа, #RGB/#RRGGBB и $path как EntityPath; другие значения остаются строками. Несколько значений через запятую становятся Array. При неверном числе знаков = возвращает уже накопленный частичный Dictionary. Array и Span перегрузки используют один разбор; не рассчитывайте на автоматическое удаление произвольных пробелов.
| Имя | Тип | По умолчанию |
|---|---|---|
expressions | ReadOnlySpan<string> | — |
expressionsПараметры key=value; запятая разделяет значения.
Reckfell.Collections.DictionaryРазбирает параметры вида key=value, не выполняя код или математические выражения. Распознаёт точные true/false, числа, #RGB/#RRGGBB и $path как EntityPath; другие значения остаются строками. Несколько значений через запятую становятся Array. При неверном числе знаков = возвращает уже накопленный частичный Dictionary. Array и Span перегрузки используют один разбор; не рассчитывайте на автоматическое удаление произвольных пробелов.
public Reckfell.Collections.Dictionary ParseExpressionsForValues(string[] expressions);Разбирает параметры вида key=value, не выполняя код или математические выражения. Распознаёт точные true/false, числа, #RGB/#RRGGBB и $path как EntityPath; другие значения остаются строками. Несколько значений через запятую становятся Array. При неверном числе знаков = возвращает уже накопленный частичный Dictionary. Array и Span перегрузки используют один разбор; не рассчитывайте на автоматическое удаление произвольных пробелов.
| Имя | Тип | По умолчанию |
|---|---|---|
expressions | string[] | — |
expressionsПараметры key=value; запятая разделяет значения.
Reckfell.Collections.DictionaryРазбирает параметры вида key=value, не выполняя код или математические выражения. Распознаёт точные true/false, числа, #RGB/#RRGGBB и $path как EntityPath; другие значения остаются строками. Несколько значений через запятую становятся Array. При неверном числе знаков = возвращает уже накопленный частичный Dictionary. Array и Span перегрузки используют один разбор; не рассчитывайте на автоматическое удаление произвольных пробелов.
Popvoid
public void Pop();Закрывает одну текущую область форматирования, сохраняя её содержимое. Вызывайте только после соответствующего Push: у корневого уровня нет родителя. Не удаляет последний символ.
PopAllvoid
public void PopAll();Возвращает текущую область к корню без удаления содержимого. Это сброс позиции построения, не Clear и не надёжный способ закрыть неправильно составленную строку BBCode.
PopContextvoid
public void PopContext();Выходит из вложенных областей до ближайшей границы PushContext включительно. Без такой границы поднимается к корню. Уже добавленный текст остаётся.
PushBgcolorvoid
public void PushBgcolor(Color bgcolor);Открывает область фоновой прямоугольной заливки под текстом; это не цвет глифов PushColor. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
bgcolor | Color | — |
bgcolorЦвет заливки под текстом.
PushBoldvoid
public void PushBold();Открывает область жирного шрифта темы; при активном курсиве выбирает сочетание жирного и курсива. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
PushBoldItalicsvoid
public void PushBoldItalics();Открывает область жирного курсивного шрифта темы. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
PushCellvoid
public void PushCell();Открывает следующую ячейку только когда текущая область — таблица. Сразу настройте SetCell-методы, затем добавляйте текст и форматирование; Pop возвращает в таблицу. После каждого количества ячеек, равного числу столбцов, начинается следующая строка. Внутри ячейки можно открыть вложенную таблицу.
PushColorvoid
public void PushColor(Color color);Открывает область цвета глифов текста с учётом альфы. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
color | Color | — |
colorЦвет соответствующего текста, контура или линии.
PushContextvoid
public void PushContext();Ставит границу контекста для группы последующих Push-областей. PopContext закрывает вложенные области до этой границы; это не отмена уже добавленного текста.
PushCustomfxvoid
public void PushCustomfx(RichTextEffect effect, Reckfell.Collections.Dictionary env);Открывает область эффекта: вызовите PushCustomfx, добавьте текст через AddText и закройте Pop. Позволяет использовать ресурс напрямую без регистрации BBCode-тега. env передаётся по общей ссылке; для независимых параметров создайте отдельный словарь. Не создаёт текст и не запускает эффект на уже завершённых областях.
| Имя | Тип | По умолчанию |
|---|---|---|
effect | RichTextEffect | — |
env | Reckfell.Collections.Dictionary | — |
effectДействительный ресурс RichTextEffect.
envОтдельный словарь параметров области; сохраняется по общей ссылке.
PushDropcapvoid
public void PushDropcap(string @string, Font font, int size, Rect2? dropcapMargins = default, Color? color = default, int outlineSize = 0, Color? outlineColor = default);Добавляет декоративную буквицу как самостоятельное содержимое: нужны непустой текст, действительный Font и положительный размер. В отличие от обычных Push-областей не требует собственного Pop. Не меняет уже добавленную первую букву и не дописывает исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
string | string | — |
font | Font | — |
size | int | — |
dropcapMargins | Rect2? | default |
color | Color? | default |
outlineSize | int | 0 |
outlineColor | Color? | default |
stringНепустой текст буквицы.
fontДействительный общий ресурс Font.
sizeПоложительный размер шрифта буквицы в пикселях.
dropcapMarginsПоля вокруг буквицы как Rect2.
colorЦвет соответствующего текста, контура или линии.
outlineSizeНеотрицательная толщина контура в пикселях.
outlineColorЦвет контура буквицы.
PushFgcolorvoid
public void PushFgcolor(Color fgcolor);Открывает область прямоугольной заливки переднего плана поверх текста. Для обычного цвета букв используйте PushColor; непрозрачная заливка может закрыть буквы. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
fgcolor | Color | — |
fgcolorЦвет заливки поверх текста.
PushFontvoid
public void PushFont(Font font, int fontSize = 0);Открывает область заданного ресурса Font и необязательного размера. Ресурс общий; не освобождайте его как заимствованный объект метки. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
font | Font | — |
fontSize | int | 0 |
fontДействительный общий ресурс Font.
fontSizeРазмер шрифта в пикселях; у PushFont 0 оставляет размер по текущим правилам.
PushFontSizevoid
public void PushFontSize(int fontSize);Открывает область положительного размера шрифта в пикселях, сохраняя выбранный шрифт. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
fontSize | int | — |
fontSizeРазмер шрифта в пикселях; у PushFont 0 оставляет размер по текущим правилам.
PushHintvoid
public void PushHint(string description);Открывает область текстовой подсказки для следующего содержимого. Добавьте текст и вызовите Pop. Не добавляет самостоятельный символ или обработчик перехода.
| Имя | Тип | По умолчанию |
|---|---|---|
description | string | — |
descriptionТекст подсказки следующей области.
PushIndentvoid
public void PushIndent(int level);Открывает область отступа с неотрицательным уровнем. Не вставляет пробелы в исходный Text. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
level | int | — |
levelНеотрицательный уровень отступа/списка.
PushItalicsvoid
public void PushItalics();Открывает область курсивного шрифта темы; при активном жирном выбирает жирный курсив. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
PushLanguagevoid
public void PushLanguage(string language);Открывает область языковой подсказки для формирования текста. Не переводит её содержимое. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
language | string | — |
languageЯзыковая подсказка формирования, не целевой язык перевода.
PushList2 перегрузки
public void PushList(int level, RichTextLabel.ListType type, bool capitalize);Открывает список заданного типа и уровня. Добавляйте текст пунктов, разделяя их Newline; маркеры и нумерация относятся к отображению, не к исходной BBCode-строке. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
level | int | — |
type | RichTextLabel.ListType | — |
capitalize | bool | — |
levelНеотрицательный уровень отступа/списка.
typeТип маркера или нумерации списка ListType.
capitalizeИспользовать верхний регистр в буквенной/римской нумерации.
public void PushList(int level, RichTextLabel.ListType type, bool capitalize, string bullet = "\u2022");Открывает список заданного типа и уровня. Добавляйте текст пунктов, разделяя их Newline; маркеры и нумерация относятся к отображению, не к исходной BBCode-строке. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
level | int | — |
type | RichTextLabel.ListType | — |
capitalize | bool | — |
bullet | string | "\u2022" |
levelНеотрицательный уровень отступа/списка.
typeТип маркера или нумерации списка ListType.
capitalizeИспользовать верхний регистр в буквенной/римской нумерации.
bulletСтрока маркера маркированного списка.
PushMeta3 перегрузки
public void PushMeta(Variant data);Открывает область метаданных для следующего текста; закройте её Pop. data передаётся событиям MetaClicked/MetaHoverStarted/MetaHoverEnded. Это может быть ID или URL, но сам RichTextLabel его не открывает. underlineMode управляет видом ссылки, tooltip — подсказкой.
| Имя | Тип | По умолчанию |
|---|---|---|
data | Variant | — |
dataМетаданные области как Variant, например ID или URL.
public void PushMeta(Variant data, RichTextLabel.MetaUnderline underlineMode);Открывает область метаданных для следующего текста; закройте её Pop. data передаётся событиям MetaClicked/MetaHoverStarted/MetaHoverEnded. Это может быть ID или URL, но сам RichTextLabel его не открывает. underlineMode управляет видом ссылки, tooltip — подсказкой.
| Имя | Тип | По умолчанию |
|---|---|---|
data | Variant | — |
underlineMode | RichTextLabel.MetaUnderline | — |
dataМетаданные области как Variant, например ID или URL.
underlineModeУсловия подчёркивания области метаданных.
public void PushMeta(Variant data, RichTextLabel.MetaUnderline underlineMode = RichTextLabel.MetaUnderline.Always, string tooltip = "");Открывает область метаданных для следующего текста; закройте её Pop. data передаётся событиям MetaClicked/MetaHoverStarted/MetaHoverEnded. Это может быть ID или URL, но сам RichTextLabel его не открывает. underlineMode управляет видом ссылки, tooltip — подсказкой.
| Имя | Тип | По умолчанию |
|---|---|---|
data | Variant | — |
underlineMode | RichTextLabel.MetaUnderline | RichTextLabel.MetaUnderline.Always |
tooltip | string | "" |
dataМетаданные области как Variant, например ID или URL.
underlineModeУсловия подчёркивания области метаданных.
tooltipТекст подсказки области, пустая строка — без явной подсказки.
PushMonovoid
public void PushMono();Открывает область моноширинного шрифта темы. Не включает подсветку кода или анализ языка. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
PushNormalvoid
public void PushNormal();Открывает область обычного шрифта темы. Не сбрасывает все прочие цвета, отступы и вложенные области. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
PushOutlineColorvoid
public void PushOutlineColor(Color color);Открывает область цвета контура глифов. Само по себе не задаёт ненулевую толщину контура. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
color | Color | — |
colorЦвет соответствующего текста, контура или линии.
PushOutlineSizevoid
public void PushOutlineSize(int outlineSize);Открывает область толщины контура в пикселях; 0 отключает контур в этой области. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
outlineSize | int | — |
outlineSizeНеотрицательная толщина контура в пикселях.
PushParagraph3 перегрузки
public void PushParagraph(HorizontalAlignment alignment, Control.TextDirection baseDirection, string language, TextServer.StructuredTextParser stParser);Открывает область параметров абзаца: выравнивание, направление, язык, BiDi-парсер, выравнивание по ширине и tab-позиции. Это параметры содержимого, не контейнер Control. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
alignment | HorizontalAlignment | — |
baseDirection | Control.TextDirection | — |
language | string | — |
stParser | TextServer.StructuredTextParser | — |
alignmentГоризонтальное выравнивание содержимого абзаца.
baseDirectionБазовое направление BiDi-текста.
languageЯзыковая подсказка формирования, не целевой язык перевода.
stParserРежим разбора структурированного двунаправленного текста.
public void PushParagraph(HorizontalAlignment alignment, Control.TextDirection baseDirection, string language, TextServer.StructuredTextParser stParser, TextServer.JustificationFlag justificationFlags, ReadOnlySpan<float> tabStops);Открывает область параметров абзаца: выравнивание, направление, язык, BiDi-парсер, выравнивание по ширине и tab-позиции. Это параметры содержимого, не контейнер Control. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
alignment | HorizontalAlignment | — |
baseDirection | Control.TextDirection | — |
language | string | — |
stParser | TextServer.StructuredTextParser | — |
justificationFlags | TextServer.JustificationFlag | — |
tabStops | ReadOnlySpan<float> | — |
alignmentГоризонтальное выравнивание содержимого абзаца.
baseDirectionБазовое направление BiDi-текста.
languageЯзыковая подсказка формирования, не целевой язык перевода.
stParserРежим разбора структурированного двунаправленного текста.
justificationFlagsБиты правил выравнивания по ширине.
tabStopsПозиции табуляции в пикселях.
public void PushParagraph(HorizontalAlignment alignment, Control.TextDirection baseDirection = Control.TextDirection.Auto, string language = "", TextServer.StructuredTextParser stParser = TextServer.StructuredTextParser.Default, TextServer.JustificationFlag justificationFlags = TextServer.JustificationFlag.Kashida | TextServer.JustificationFlag.WordBound | TextServer.JustificationFlag.SkipLastLine | TextServer.JustificationFlag.DoNotSkipSingleLine, float[] tabStops = null);Открывает область параметров абзаца: выравнивание, направление, язык, BiDi-парсер, выравнивание по ширине и tab-позиции. Это параметры содержимого, не контейнер Control. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
alignment | HorizontalAlignment | — |
baseDirection | Control.TextDirection | Control.TextDirection.Auto |
language | string | "" |
stParser | TextServer.StructuredTextParser | TextServer.StructuredTextParser.Default |
justificationFlags | TextServer.JustificationFlag | TextServer.JustificationFlag.Kashida | TextServer.JustificationFlag.WordBound | TextServer.JustificationFlag.SkipLastLine | TextServer.JustificationFlag.DoNotSkipSingleLine |
tabStops | float[] | null |
alignmentГоризонтальное выравнивание содержимого абзаца.
baseDirectionБазовое направление BiDi-текста.
languageЯзыковая подсказка формирования, не целевой язык перевода.
stParserРежим разбора структурированного двунаправленного текста.
justificationFlagsБиты правил выравнивания по ширине.
tabStopsПозиции табуляции в пикселях.
PushStrikethrough2 перегрузки
public void PushStrikethrough();Открывает перечёркивание текста. Не удаляет символы из GetParsedText или выделения. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
public void PushStrikethrough(Color? color = default);Открывает перечёркивание текста. Не удаляет символы из GetParsedText или выделения. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
color | Color? | default |
colorЦвет соответствующего текста, контура или линии.
PushTable2 перегрузки
public void PushTable(int columns, InlineAlignment inlineAlign, int alignToRow);Открывает таблицу с положительным числом столбцов. Затем настройте столбцы, для каждой ячейки вызовите PushCell, добавьте содержимое и закройте ячейку Pop; после всех ячеек ещё один Pop закрывает таблицу. Ячейки заполняются по порядку строк; отдельного PushRow нет. alignToRow выбирает строку для вертикального выравнивания, -1 — последнюю. name задаёт описание для доступности, не видимый заголовок.
| Имя | Тип | По умолчанию |
|---|---|---|
columns | int | — |
inlineAlign | InlineAlignment | — |
alignToRow | int | — |
columnsПоложительное число столбцов таблицы.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
alignToRowИндекс строки выравнивания от 0; -1 выбирает последнюю.
public void PushTable(int columns, InlineAlignment inlineAlign = InlineAlignment.TopTo, int alignToRow = -1, string name = "");Открывает таблицу с положительным числом столбцов. Затем настройте столбцы, для каждой ячейки вызовите PushCell, добавьте содержимое и закройте ячейку Pop; после всех ячеек ещё один Pop закрывает таблицу. Ячейки заполняются по порядку строк; отдельного PushRow нет. alignToRow выбирает строку для вертикального выравнивания, -1 — последнюю. name задаёт описание для доступности, не видимый заголовок.
| Имя | Тип | По умолчанию |
|---|---|---|
columns | int | — |
inlineAlign | InlineAlignment | InlineAlignment.TopTo |
alignToRow | int | -1 |
name | string | "" |
columnsПоложительное число столбцов таблицы.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
alignToRowИндекс строки выравнивания от 0; -1 выбирает последнюю.
nameИмя для доступности таблицы или столбца, не вставляемый заголовок.
PushUnderline2 перегрузки
public void PushUnderline();Открывает подчёркивание текста. Прозрачный цвет с alpha = 0 означает использование текущего цвета текста и альфы темы, а не невидимую линию. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
public void PushUnderline(Color? color = default);Открывает подчёркивание текста. Прозрачный цвет с alpha = 0 означает использование текущего цвета текста и альфы темы, а не невидимую линию. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.
| Имя | Тип | По умолчанию |
|---|---|---|
color | Color? | default |
colorЦвет соответствующего текста, контура или линии.
ReloadEffectsvoid
public void ReloadEffects();Повторно разбирает сохранённый Text только при включённом BBCode и отсутствии внешнего ручного изменения стека. Для вручную построенных областей не является универсальной перезагрузкой: перестройте нужное содержимое явно.
RemoveParagraph2 перегрузки
public bool RemoveParagraph(int paragraph);Удаляет абзац основного потока вместе с принадлежащим содержимым и снимает выделение. Индексы последующих абзацев сдвигаются; при удалении единственного остаётся пустое содержимое с одним абзацем. Не переписывает исходный Text и не имеет встроенного Undo. noInvalidate = false пересчитывает затронутые кэши; true оставляет их для оптимизированного пути, который требует отдельно обеспечить актуальность данных. Возвращает false для неверного индекса.
| Имя | Тип | По умолчанию |
|---|---|---|
paragraph | int | — |
paragraphИндекс абзаца основного потока от 0 до GetParagraphCount() - 1.
boolУдаляет абзац основного потока вместе с принадлежащим содержимым и снимает выделение. Индексы последующих абзацев сдвигаются; при удалении единственного остаётся пустое содержимое с одним абзацем. Не переписывает исходный Text и не имеет встроенного Undo. noInvalidate = false пересчитывает затронутые кэши; true оставляет их для оптимизированного пути, который требует отдельно обеспечить актуальность данных. Возвращает false для неверного индекса.
public bool RemoveParagraph(int paragraph, bool noInvalidate = false);Удаляет абзац основного потока вместе с принадлежащим содержимым и снимает выделение. Индексы последующих абзацев сдвигаются; при удалении единственного остаётся пустое содержимое с одним абзацем. Не переписывает исходный Text и не имеет встроенного Undo. noInvalidate = false пересчитывает затронутые кэши; true оставляет их для оптимизированного пути, который требует отдельно обеспечить актуальность данных. Возвращает false для неверного индекса.
| Имя | Тип | По умолчанию |
|---|---|---|
paragraph | int | — |
noInvalidate | bool | false |
paragraphИндекс абзаца основного потока от 0 до GetParagraphCount() - 1.
noInvalidateОставить кэши для оптимизированного пути; обычно используйте false.
boolУдаляет абзац основного потока вместе с принадлежащим содержимым и снимает выделение. Индексы последующих абзацев сдвигаются; при удалении единственного остаётся пустое содержимое с одним абзацем. Не переписывает исходный Text и не имеет встроенного Undo. noInvalidate = false пересчитывает затронутые кэши; true оставляет их для оптимизированного пути, который требует отдельно обеспечить актуальность данных. Возвращает false для неверного индекса.
ScrollToLinevoid
public void ScrollToLine(int line);Прокручивает к визуальной строке переноса, не к логической строке исходного BBCode. Значения <= 0 ведут к началу, слишком большой индекс — к концу доступного расчёта. Сначала дождитесь готовности, если нужна точная позиция.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
lineИндекс визуальной строки переноса от 0.
ScrollToParagraphvoid
public void ScrollToParagraph(int paragraph);Прокручивает к абзацу основного содержимого. Значения <= 0 ведут к началу, за пределами рассчитанных абзацев — к концу полосы. Не выделяет текст и не меняет его.
| Имя | Тип | По умолчанию |
|---|---|---|
paragraph | int | — |
paragraphИндекс абзаца основного потока от 0.
ScrollToSelectionvoid
public void ScrollToSelection();Прокручивает к началу текущего выделения по GetSelectionLineOffset. При отсутствии выделения ничего не делает. Не создаёт выделение и не изменяет содержимое.
SelectAllvoid
public void SelectAll();Выделяет построенное содержимое при SelectionEnabled. Не выполняет копирование в буфер. При фоновом расчёте сначала дождитесь IsFinished, чтобы границы охватывали готовое содержимое.
SetAutowrapModevoid
public void SetAutowrapMode(TextServer.AutowrapMode autowrapMode);Правило переноса по доступной ширине: отключение, произвольный перенос или перенос по словам. Меняет визуальные строки и размеры, сохраняя исходный Text. Для предсказуемого результата задайте метке ширину через компоновку.
| Имя | Тип | По умолчанию |
|---|---|---|
autowrapMode | TextServer.AutowrapMode | — |
autowrapModeРежим переноса по доступной ширине.
SetAutowrapTrimFlagsvoid
public void SetAutowrapTrimFlags(TextServer.LineBreakFlag autowrapTrimFlags);Флаги обработки краевых пробелов и отступа при переносе. Setter сохраняет только биты trim-маски TextServer; другие LineBreakFlag не включают здесь собственный режим переноса. Исходный текст не обрезается.
| Имя | Тип | По умолчанию |
|---|---|---|
autowrapTrimFlags | TextServer.LineBreakFlag | — |
autowrapTrimFlagsБиты обработки краевых пробелов/отступа; сохраняется только trim-маска.
SetCellBorderColorvoid
public void SetCellBorderColor(Color color);Задаёт цвет границы только текущей ячейки. Color(0,0,0,0) служит возвратом к цвету темы, поэтому не гарантирует скрытую границу при ненулевой теме. Настраивайте непосредственно в ячейке до открытия вложенных Push-областей.
| Имя | Тип | По умолчанию |
|---|---|---|
color | Color | — |
colorМодуляция изображения или цвет соответствующего оформления.
SetCellPaddingvoid
public void SetCellPadding(Rect2 padding);Задаёт внутренние поля текущей ячейки: Rect2.Position.X/Y — слева/сверху, Rect2.Size.X/Y — справа/снизу. Это упаковка четырёх полей, не обычный прямоугольник с шириной и высотой. Используйте неотрицательные значения и настраивайте сразу после PushCell.
| Имя | Тип | По умолчанию |
|---|---|---|
padding | Rect2 | — |
paddingRect2(left, top, right, bottom) в пикселях полей.
SetCellRowBackgroundColorvoid
public void SetCellRowBackgroundColor(Color oddRowBg, Color evenRowBg);Задаёт два цвета фона текущей ячейки; при отрисовке выбирается цвет по чётности строки таблицы. Не перекрашивает автоматически остальные ячейки этой строки. Color(0,0,0,0) возвращает соответствующий фон темы.
| Имя | Тип | По умолчанию |
|---|---|---|
oddRowBg | Color | — |
evenRowBg | Color | — |
oddRowBgФон этой ячейки для нечётной строки; нулевой Color возвращает тему.
evenRowBgФон этой ячейки для чётной строки; нулевой Color возвращает тему.
SetCellSizeOverridevoid
public void SetCellSizeOverride(Vector2 minSize, Vector2 maxSize);Сохраняет ограничения размеров текущей ячейки. В текущей реализации раскладки используются положительные Y как минимум/максимум высоты; X не задаёт ширину столбца. Неположительный Y означает отсутствие соответствующего ограничения. В многоабзацной ячейке Y ограничивает расчётную высоту отдельных абзацев, не их общую сумму. Для ширины настройте столбцы; min/max должны быть согласованы. Вызывайте сразу после PushCell.
| Имя | Тип | По умолчанию |
|---|---|---|
minSize | Vector2 | — |
maxSize | Vector2 | — |
minSizeВ текущей раскладке положительный Y ограничивает высоту снизу; X не задаёт ширину.
maxSizeВ текущей раскладке положительный Y ограничивает высоту сверху; <= 0 снимает ограничение.
SetContextMenuEnabledvoid
public void SetContextMenuEnabled(bool enabled);Разрешает открытие встроенного пользовательского меню. false не удаляет PopupMenu и не запрещает программные GetMenu/MenuOption. Это настройка интерфейса, а не запрет копирования данных приложением.
| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
enabledВключить описанную настройку взаимодействия.
SetDeselectOnFocusLossEnabledvoid
public void SetDeselectOnFocusLossEnabled(bool enable);Разрешает снятие выделения при потере фокуса. При переключении false → true у метки без фокуса существующее выделение снимается сразу. Для сохранения выделения при переходе к другому элементу используйте false.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
enableВключить описанную настройку взаимодействия.
SetDragAndDropSelectionEnabledvoid
public void SetDragAndDropSelectionEnabled(bool enable);Разрешает пользовательское перетаскивание выделенного обычного текста из метки. Нужно SelectionEnabled; не включает редактирование или приём произвольных файлов. Назначение свойства не запускает перенос.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
enableВключить описанную настройку взаимодействия.
SetEffectsvoid
public void SetEffects(Reckfell.Collections.Array effects);Ресурсы пользовательских BBCode-эффектов. Setter заменяет массив и вызывает ReloadEffects; getter разделяет массив, поэтому изменение результата само по себе не перезапускает разбор. Эффекты с совпадающими именами неоднозначны: используется первое подходящее имя. Для прямого программного применения используйте PushCustomfx.
| Имя | Тип | По умолчанию |
|---|---|---|
effects | Reckfell.Collections.Array | — |
effectsМассив ресурсов RichTextEffect для зарегистрированных тегов.
SetFitContentvoid
public void SetFitContent(bool enabled);Учитывает содержимое в минимальном размере метки. Родительский контейнер может расширить элемент; это не команда установить точный Size и не уменьшение шрифта. Учитывайте взаимодействие с переносами и ограничениями родителя.
| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
enabledВключить описанную настройку компоновки.
SetHintUnderlinevoid
public void SetHintUnderline(bool enable);Разрешает визуальное подчёркивание областей PushHint. Не включает или отключает само содержимое подсказки и не меняет текст.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
enableВключить описанную настройку взаимодействия.
SetHorizontalAlignmentvoid
public void SetHorizontalAlignment(HorizontalAlignment alignment);Выравнивание основного текста по горизонтали; локальная разметка абзаца может задавать своё. Fill использует JustificationFlags для выравнивания по ширине. Не перемещает сам Control в родительском контейнере.
| Имя | Тип | По умолчанию |
|---|---|---|
alignment | HorizontalAlignment | — |
alignmentВыравнивание текста внутри метки.
SetJustificationFlagsvoid
public void SetJustificationFlags(TextServer.JustificationFlag justificationFlags);Правила растяжения строк при выравнивании по ширине, например обработка слов и последней строки. Действуют вместе с соответствующим выравниванием; не задают ширину метки.
| Имя | Тип | По умолчанию |
|---|---|---|
justificationFlags | TextServer.JustificationFlag | — |
justificationFlagsБиты правил выравнивания текста по ширине.
SetLanguagevoid
public void SetLanguage(string language);Языковая подсказка текстовой системе для формирования и переноса. Не переводит строку на другой язык; перевод UI исходного Text — отдельный механизм.
| Имя | Тип | По умолчанию |
|---|---|---|
language | string | — |
languageКод языковой подсказки для формирования текста.
SetMaximumFontSizevoid
public void SetMaximumFontSize(int size);Верхняя граница подбора при ResizeFontToFit. Согласуйте с MinimumFontSize; это ограничение подбора, а не общий запрет локальных размеров BBCode.
| Имя | Тип | По умолчанию |
|---|---|---|
size | int | — |
sizeПоложительная граница подбора шрифта, согласованная со второй границей.
SetMetaUnderlinevoid
public void SetMetaUnderline(bool enable);Разрешает подчёркивание областей метаданных с учётом их MetaUnderline. Не создаёт ссылку и не открывает URL. Явная область PushUnderline остаётся отдельным форматированием.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
enableВключить описанную настройку взаимодействия.
SetMinimumFontSizevoid
public void SetMinimumFontSize(int size);Нижняя граница подбора при ResizeFontToFit. Задавайте положительное значение не больше MaximumFontSize. Само назначение не означает, что именно этот размер уже нарисован.
| Имя | Тип | По умолчанию |
|---|---|---|
size | int | — |
sizeПоложительная граница подбора шрифта, согласованная со второй границей.
SetProgressBarDelayvoid
public void SetProgressBarDelay(int delayMs);Задержка показа индикатора фоновой загрузки в миллисекундах. Положительное значение ждёт этот интервал; 0 и отрицательные значения отключают индикатор. Не задаёт скорость разбора или задержку появления символов.
| Имя | Тип | По умолчанию |
|---|---|---|
delayMs | int | — |
delayMsПоложительная задержка в миллисекундах; <= 0 отключает индикатор.
SetResizeFontToFitvoid
public void SetResizeFontToFit(bool enabled);Разрешает подбирать размер основного шрифта для доступной области в диапазоне MinimumFontSize–MaximumFontSize. Не заменяет FitContent: здесь меняется шрифт, а не требование минимального размера. Подбор зависит от ширины и высоты; слишком маленький минимум не гарантирует читаемость.
| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
enabledВключить описанную настройку компоновки.
SetScrollActivevoid
public void SetScrollActive(bool active);Разрешает встроенную вертикальную прокрутку. Переключение вызывает повторное применение исходного Text: при смешении с ручным AddText/Push содержимое может быть перестроено из сохранённой строки. Задавайте режим до ручного построения. Не означает, что всё содержимое помещается без полосы.
| Имя | Тип | По умолчанию |
|---|---|---|
active | bool | — |
activeРазрешить встроенную вертикальную прокрутку.
SetScrollFollowvoid
public void SetScrollFollow(bool follow);Разрешает следование за концом дополняемого текста. Если пользователь прокрутил вверх, фактическое следование может приостановиться до возвращения к низу. Getter сообщает настройку, а не факт положения внизу.
| Имя | Тип | По умолчанию |
|---|---|---|
follow | bool | — |
followВключить соответствующий режим следования прокрутки.
SetScrollFollowVisibleCharactersvoid
public void SetScrollFollowVisibleCharacters(bool follow);Прокручивает к области, раскрываемой через VisibleCharacters. Отличается от следования за полным концом текста: предназначено для постепенного показа. Назначение true может сразу изменить прокрутку.
| Имя | Тип | По умолчанию |
|---|---|---|
follow | bool | — |
followВключить соответствующий режим следования прокрутки.
SetSelectionEnabledvoid
public void SetSelectionEnabled(bool enabled);Разрешает выделение отображаемого текста и SelectAll. Включение задаёт FocusMode.All; отключение снимает активное выделение и устанавливает режим фокуса доступности. Не делает метку редактируемой и не изменяет Text.
| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
enabledВключить описанную настройку взаимодействия.
SetShortcutKeysEnabledvoid
public void SetShortcutKeysEnabled(bool enabled);Разрешает встроенные сочетания команд метки. Не включает SelectionEnabled автоматически и не запрещает прямые программные вызовы SelectAll/MenuOption.
| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
enabledВключить описанную настройку взаимодействия.
SetStructuredTextBidiOverridevoid
public void SetStructuredTextBidiOverride(TextServer.StructuredTextParser parser);Выбирает разбор структурированного двунаправленного текста, например адресов и путей. Это настройка формирования, не regex-замена исходной строки. Параметры задаёт StructuredTextBidiOverrideOptions.
| Имя | Тип | По умолчанию |
|---|---|---|
parser | TextServer.StructuredTextParser | — |
parserРежим разбора структурированного BiDi-текста.
SetStructuredTextBidiOverrideOptionsvoid
public void SetStructuredTextBidiOverrideOptions(Reckfell.Collections.Array args);Параметры структурированного BiDi-разбора. Массив сохраняется по общей ссылке; изменение его содержимого не запускает перерасчёт автоматически. Для обновления назначьте новый массив с отличающимся содержимым: равное содержимое setter может пропустить.
| Имя | Тип | По умолчанию |
|---|---|---|
args | Reckfell.Collections.Array | — |
argsПараметры парсера; массив сохраняется по общей ссылке.
SetTabSizevoid
public void SetTabSize(int spaces);Ширина стандартного шага табуляции в пробелах; используйте положительное значение. Меняет отображение tab, не заменяет его пробелами в Text. Для явных позиций используйте TabStops.
| Имя | Тип | По умолчанию |
|---|---|---|
spaces | int | — |
spacesПоложительный размер шага tab в пробелах.
SetTabStops2 перегрузки
public void SetTabStops(ReadOnlySpan<float> tabStops);Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.
| Имя | Тип | По умолчанию |
|---|---|---|
tabStops | ReadOnlySpan<float> | — |
tabStopsВозрастающие положительные позиции tab в пикселях.
public void SetTabStops(float[] tabStops);Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.
| Имя | Тип | По умолчанию |
|---|---|---|
tabStops | float[] | — |
tabStopsВозрастающие положительные позиции tab в пикселях.
SetTableColumnExpand2 перегрузки
public void SetTableColumnExpand(int column, bool expand, int ratio);Настраивает текущую открытую таблицу; вызывайте до PushCell либо после Pop ячейки. column — индекс от 0, ratio — положительный относительный вес, не пиксели или проценты. expand разрешает распределение места; shrink = true ограничивает растяжение естественным максимумом содержимого, false допускает больше свободной ширины. Это не гарантия фиксированных долей всей таблицы: учитываются минимумы и максимумы. Короткая перегрузка использует shrink = true.
| Имя | Тип | По умолчанию |
|---|---|---|
column | int | — |
expand | bool | — |
ratio | int | — |
columnИндекс существующего столбца от 0.
expandУчаствовать в распределении ширины таблицы.
ratioПоложительный относительный вес растяжения.
public void SetTableColumnExpand(int column, bool expand, int ratio = 1, bool shrink = true);Настраивает текущую открытую таблицу; вызывайте до PushCell либо после Pop ячейки. column — индекс от 0, ratio — положительный относительный вес, не пиксели или проценты. expand разрешает распределение места; shrink = true ограничивает растяжение естественным максимумом содержимого, false допускает больше свободной ширины. Это не гарантия фиксированных долей всей таблицы: учитываются минимумы и максимумы. Короткая перегрузка использует shrink = true.
| Имя | Тип | По умолчанию |
|---|---|---|
column | int | — |
expand | bool | — |
ratio | int | 1 |
shrink | bool | true |
columnИндекс существующего столбца от 0.
expandУчаствовать в распределении ширины таблицы.
ratioПоложительный относительный вес растяжения.
shrinkОграничивать растяжение естественным максимумом содержимого.
SetTableColumnNamevoid
public void SetTableColumnName(int column, string name);Задаёт имя столбца текущей таблицы для доступности. Не вставляет видимую строку заголовка: создайте её ячейки отдельно. Требует текущую область таблицы, не ячейки или шрифта.
| Имя | Тип | По умолчанию |
|---|---|---|
column | int | — |
name | string | — |
columnИндекс существующего столбца от 0.
nameИмя для доступности таблицы или столбца, не вставляемый заголовок.
SetTextvoid
public void SetText(string text);Исходная строка для полного построения метки, с переводом UI и разбором BBCode при включённом BbcodeEnabled. Назначение заменяет ручное содержимое; одинаковая непустая строка может ничего не перестроить. AddText, AppendText и Push-методы не дописывают сюда свой результат. Для получившегося обычного текста используйте GetParsedText.
| Имя | Тип | По умолчанию |
|---|---|---|
text | string | — |
textИсходный или буквальный текст в зависимости от метода; AddText не разбирает теги.
SetTextDirectionvoid
public void SetTextDirection(Control.TextDirection direction);Направление текста для BiDi-формирования. Не переставляет символы исходной строки вручную и не переводит текст. Разметка структурированного текста настраивается отдельно.
| Имя | Тип | По умолчанию |
|---|---|---|
direction | Control.TextDirection | — |
directionНаправление формирования текста, не команда изменения строки.
SetThreadedvoid
public void SetThreaded(bool threaded);Разрешает фоновый расчёт раскладки текста; по умолчанию false. Не делает произвольные вызовы RichTextLabel потокобезопасными и не переносит всю отрисовку в другой поток. Следите за IsFinished; до завершения метрики могут описывать только обработанную часть.
| Имя | Тип | По умолчанию |
|---|---|---|
threaded | bool | — |
threadedРазрешить фоновый расчёт раскладки.
SetUseBbcodevoid
public void SetUseBbcode(bool enable);Определяет разбор свойства Text как BBCode. Для ручного AddText разбор не включается; AppendText самостоятельно разбирает разметку. Переключение настройки не гарантирует перестройку вручную изменённого стека.
| Имя | Тип | По умолчанию |
|---|---|---|
enable | bool | — |
enableВключить разбор Text как BBCode.
SetVerticalAlignmentvoid
public void SetVerticalAlignment(VerticalAlignment alignment);Размещение текстового содержимого по вертикали внутри области метки. Не меняет вертикальное выравнивание Control у родителя и не включает автоматическую прокрутку.
| Имя | Тип | По умолчанию |
|---|---|---|
alignment | VerticalAlignment | — |
alignmentВыравнивание текста внутри метки.
SetVisibleCharactersvoid
public void SetVisibleCharacters(int amount);Лимит постепенного показа: -1 показывает всё, 0 скрывает текст, неотрицательное значение задаёт предел. Поведение до/после формирования глифов выбирает VisibleCharactersBehavior. Это не количество кадров и не UTF-16 Length строки Text. Setter пересчитывает VisibleRatio, но не ограничивает явно слишком большое значение; для анимации держите диапазон от 0 до GetTotalCharacterCount.
| Имя | Тип | По умолчанию |
|---|---|---|
amount | int | — |
amountЛимит показа; -1 — всё, 0 — ничего.
SetVisibleCharactersBehaviorvoid
public void SetVisibleCharactersBehavior(TextServer.VisibleCharactersBehavior behavior);Определяет, применяется ли лимит до формирования текста или к уже сформированным символам/глифам. До формирования может меняться раскладка; после формирования сохраняется контекст полной строки, но единицы показа зависят от режима. Учитывайте лигатуры, составные символы и RTL; не предполагайте один char C# на один видимый глиф.
| Имя | Тип | По умолчанию |
|---|---|---|
behavior | TextServer.VisibleCharactersBehavior | — |
behaviorРежим VisibleCharactersBehavior текстовой системы.
SetVisibleRatiovoid
public void SetVisibleRatio(float ratio);Доля показа: значения от 0 до 1 переводятся в целый VisibleCharacters с усечением. Значение от 1 показывает всё, отрицательное скрывает. Не создаёт таймер: увеличивайте долю из анимации приложения. Доля относится к счётчику содержимого, не обязательно к числу визуально отдельных букв.
| Имя | Тип | По умолчанию |
|---|---|---|
ratio | float | — |
ratioДоля от 0 до 1; значения от 1 показывают всё.
UpdateImage3 перегрузки
public void UpdateImage(Variant key, RichTextLabel.ImageUpdateMask mask, Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region, bool pad, string tooltip, bool sizeInPercent);Обновляет все встроенные изображения с равным key, включая вложенные таблицы; новый элемент не создаёт. Меняются только поля, выбранные mask. В Size нулевая сторона сохраняет прежний запрошенный размер, а не сбрасывает его в авто. WidthUnit переключает единицы обеих осей. Для применения region к обычной текстуре передайте также Texture и исходный ресурс: Region без Texture меняет обрезку только у уже существующего AtlasTexture. Не переписывает исходный Text.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
mask | RichTextLabel.ImageUpdateMask | — |
image | Texture2D | — |
width | int | — |
height | int | — |
color | Color? | — |
inlineAlign | InlineAlignment | — |
region | Rect2? | — |
pad | bool | — |
tooltip | string | — |
sizeInPercent | bool | — |
keyУникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.
maskБиты ImageUpdateMask изменяемых полей. WidthUnit меняет единицы обеих осей; Size перезаписывает запрошенные числовые размеры.
imageДействительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.
widthНеотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
regionОбласть текстуры в пикселях; пустой Rect2 использует всю текстуру.
padЦентрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.
tooltipТекст подсказки изображения.
sizeInPercentВ старой перегрузке true выбирает проценты для обеих осей.
public void UpdateImage(Variant key, RichTextLabel.ImageUpdateMask mask, Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region, bool pad, string tooltip, bool widthInPercent, bool heightInPercent);Обновляет все встроенные изображения с равным key, включая вложенные таблицы; новый элемент не создаёт. Меняются только поля, выбранные mask. В Size нулевая сторона сохраняет прежний запрошенный размер, а не сбрасывает его в авто. WidthUnit переключает единицы обеих осей. Для применения region к обычной текстуре передайте также Texture и исходный ресурс: Region без Texture меняет обрезку только у уже существующего AtlasTexture. Не переписывает исходный Text.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
mask | RichTextLabel.ImageUpdateMask | — |
image | Texture2D | — |
width | int | — |
height | int | — |
color | Color? | — |
inlineAlign | InlineAlignment | — |
region | Rect2? | — |
pad | bool | — |
tooltip | string | — |
widthInPercent | bool | — |
heightInPercent | bool | — |
keyУникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.
maskБиты ImageUpdateMask изменяемых полей. WidthUnit меняет единицы обеих осей; Size перезаписывает запрошенные числовые размеры.
imageДействительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.
widthНеотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
regionОбласть текстуры в пикселях; пустой Rect2 использует всю текстуру.
padЦентрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.
tooltipТекст подсказки изображения.
widthInPercentВыбирать проценты вместо пикселей по ширине.
heightInPercentВыбирать проценты вместо пикселей по высоте; база процентов — ширина текста.
public void UpdateImage(Variant key, RichTextLabel.ImageUpdateMask mask, Texture2D image, float width = 0f, float height = 0f, Color? color = default, InlineAlignment inlineAlign = InlineAlignment.Center, Rect2? region = default, bool pad = false, string tooltip = "", RichTextLabel.ImageUnit widthUnit = RichTextLabel.ImageUnit.Pixel, RichTextLabel.ImageUnit heightUnit = RichTextLabel.ImageUnit.Pixel);Обновляет все встроенные изображения с равным key, включая вложенные таблицы; новый элемент не создаёт. Меняются только поля, выбранные mask. В Size нулевая сторона сохраняет прежний запрошенный размер, а не сбрасывает его в авто. WidthUnit переключает единицы обеих осей. Для применения region к обычной текстуре передайте также Texture и исходный ресурс: Region без Texture меняет обрезку только у уже существующего AtlasTexture. Не переписывает исходный Text.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
mask | RichTextLabel.ImageUpdateMask | — |
image | Texture2D | — |
width | float | 0f |
height | float | 0f |
color | Color? | default |
inlineAlign | InlineAlignment | InlineAlignment.Center |
region | Rect2? | default |
pad | bool | false |
tooltip | string | "" |
widthUnit | RichTextLabel.ImageUnit | RichTextLabel.ImageUnit.Pixel |
heightUnit | RichTextLabel.ImageUnit | RichTextLabel.ImageUnit.Pixel |
keyУникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.
maskБиты ImageUpdateMask изменяемых полей. WidthUnit меняет единицы обеих осей; Size перезаписывает запрошенные числовые размеры.
imageДействительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.
widthНеотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.
heightНеотрицательная высота; Percent для изображений считается от доступной ширины текста.
colorМодуляция изображения или цвет соответствующего оформления.
inlineAlignВыравнивание встроенного объекта относительно строки текста.
regionОбласть текстуры в пикселях; пустой Rect2 использует всю текстуру.
padЦентрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.
tooltipТекст подсказки изображения.
widthUnitPixel, Percent или Em для ширины; в UpdateImage применяется через маску WidthUnit.
heightUnitЕдиницы высоты; Percent использует ширину области, Em умножает размер шрифта.
Сигналы и события4
FinishedСобытие
public event Action Finished;Сигнал завершения очередного расчёта текста. Не означает, что уже нарисован кадр, закончилась анимация или новые изменения больше не потребуют расчёта. При Threaded испускается из пути рабочего потока; изменения других элементов UI переносите в основной поток через отложенный вызов.
MetaClickedСобытие
public event RichTextLabel.MetaClickedEventHandler MetaClicked;Передаёт metadata активированной области ссылки. Приложение решает, открыть URL, показать справку или выполнить своё действие. metadata — Variant, не обязательно string; сначала проверьте ожидаемый тип.
| Имя | Тип | По умолчанию |
|---|---|---|
meta | Variant | — |
metaМетаданные соответствующей области; проверьте ожидаемый тип Variant.
MetaHoverEndedСобытие
public event RichTextLabel.MetaHoverEndedEventHandler MetaHoverEnded;Передаёт метаданные области, наведение на которую завершилось. Используйте для снятия собственного состояния подсказки/подсветки.
| Имя | Тип | По умолчанию |
|---|---|---|
meta | Variant | — |
metaМетаданные соответствующей области; проверьте ожидаемый тип Variant.
MetaHoverStartedСобытие
public event RichTextLabel.MetaHoverStartedEventHandler MetaHoverStarted;Передаёт метаданные области при начале наведения. Не означает переход по ссылке или изменение выбранного текста.
| Имя | Тип | По умолчанию |
|---|---|---|
meta | Variant | — |
metaМетаданные соответствующей области; проверьте ожидаемый тип Variant.
RichTextLabel.ImageUnit
| Значение | Описание |
|---|---|
Em = 2 | Изображения, нарисованные с использованием этой единицы, будут составлять процент от размера окружающего шрифта. |
Percent = 1 | Изображения, нарисованные с использованием этой единицы, будут составлять процент от ширины элемента управления. |
Pixel = 0 | Изображения, созданные с помощью этого модуля, будут В пикселях. |
RichTextLabel.ImageUpdateMask
| Значение | Описание |
|---|---|
Alignment = 8 | Если этот бит установлен, |
Color = 4 | Если этот бит установлен, |
Pad = 32 | Если этот бит установлен, |
Region = 16 | Если этот бит установлен, |
Size = 2 | Если этот бит установлен, |
Texture = 1 | Если этот бит установлен, |
Tooltip = 64 | Если этот бит установлен, |
WidthUnit = 128 | Если этот бит установлен, метод |
RichTextLabel.ListType
| Значение | Описание |
|---|---|
Dots = 3 | Каждый элемент списка имеет маркер в виде заполненного круга. |
Letters = 1 | Каждый элемент списка имеет буквенный маркер. |
Numbers = 0 | Каждый элемент списка имеет числовой маркер. СПИСОК ИСТОЧНИКОВ |
Roman = 2 | Каждый пункт списка имеет римский номер-маркер. |
RichTextLabel.MenuItems
| Значение | Описание |
|---|---|
Copy = 0 | Копирует выделенный текст. |
Max = 2 | Представляет размер перечисления |
SelectAll = 1 | Выделяет весь текст |
RichTextLabel.MetaUnderline
| Значение | Описание |
|---|---|
Always = 1 | Если |
Never = 0 | Метатег не отображает подчеркивание, даже если |
OnHover = 2 | Если |
Свойства темы
Это ключи ресурсов Theme, а не свойства C# класса. Используйте методы GetTheme…() и AddTheme…Override() у Control с соответствующим типом значения.
| Ключ и тип | Описание |
|---|---|
default_colorColor | Цвет текста по умолчанию. По умолчанию:Color(1, 1, 1, 1) |
font_outline_colorColor | Оттенок контура текста по умолчанию. По умолчанию:Color(0, 0, 0, 1) |
font_selected_colorColor | Цвет выделенного текста, используемый, когда Color(0, 0, 0, 0) |
font_shadow_colorColor | Цвет тени шрифта. По умолчанию:Color(0, 0, 0, 0) |
selection_colorColor | Цвет поля выбора. По умолчанию:Color(0.1, 0.1, 1, 0.8) |
table_borderColor | Цвет границы ячейки по умолчанию. По умолчанию:Color(0, 0, 0, 0) |
table_even_row_bgColor | Цвет фона по умолчанию для четных строк. По умолчанию:Color(0, 0, 0, 0) |
table_odd_row_bgColor | Цвет фона по умолчанию для нечетных строк. По умолчанию:Color(0, 0, 0, 0) |
line_separationint | Дополнительный вертикальный интервал между строками (в пикселях), интервал добавляется к спуску строки. Это значение может быть отрицательным. По умолчанию:0 |
outline_sizeint | Размер контура текста.
Примечание: При использовании шрифта с включенным 0 |
paragraph_separationint | Дополнительный вертикальный интервал между абзацами (в пикселях). Интервал добавляется после последней строки. Это значение может быть отрицательным. По умолчанию:0 |
shadow_offset_xint | Горизонтальное смещение тени шрифта. По умолчанию:1 |
shadow_offset_yint | Вертикальное смещение тени шрифта. По умолчанию:1 |
shadow_outline_sizeint | Размер контура тени. По умолчанию:1 |
strikethrough_alphaint | Прозрачность цвета зачеркивания по умолчанию (в процентах). Для зачеркивания с пользовательским цветом этот элемент темы используется только в том случае, если альфа пользовательского цвета равна 50 |
table_h_separationint | Горизонтальное разделение элементов в таблице. По умолчанию:3 |
table_v_separationint | Вертикальное разделение элементов в таблице. По умолчанию:3 |
text_highlight_h_paddingint | Горизонтальный отступ вокруг полей, нарисованных тегами 3 |
text_highlight_v_paddingint | Вертикальный отступ вокруг полей, нарисованных тегами 3 |
underline_alphaint | Прозрачность цвета подчеркивания по умолчанию (в процентах). Для подчеркиваний с пользовательским цветом этот элемент темы используется только в том случае, если альфа пользовательского цвета равна 50 |
bold_fontFont | Шрифт, используемый для жирного текста. |
bold_italics_fontFont | Шрифт, используемый для жирного курсивного текста. |
italics_fontFont | Шрифт, используемый для курсивного текста. |
mono_fontFont | Шрифт, используемый для моноширинного текста. |
normal_fontFont | Шрифт текста по умолчанию. |
bold_font_sizeint | Размер шрифта, используемый для жирного текста. |
bold_italics_font_sizeint | Размер шрифта, используемый для жирного курсивного текста. |
italics_font_sizeint | Размер шрифта, используемый для курсивного текста. |
mono_font_sizeint | Размер шрифта, используемый для моноширинного текста. |
normal_font_sizeint | Размер шрифта текста по умолчанию. |
horizontal_ruleTexture2D | Текстура горизонтальной линейки. Сосредоточься |
focusStyleBox | Фон, используемый при фокусировке |
normalStyleBox | Обычный фон для |