reckfellENGINE

RichTextLabel

Метка для текста с BBCode, встроенными объектами и эффектами.

На этой странице
class RichTextLabelReckfellSharpНаследует Control

RichTextLabel отображает форматированный текст. Для статической строки включите BbcodeEnabled и назначьте Text; для последовательного построения используйте Push-методы, AddText и Pop. AddText выводит скобки и теги буквально, AppendText разбирает BBCode. Не смешивайте исходное Text и ручное построение без явного сброса: Text не становится копией получившегося содержимого.

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

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

RichTextLabelКонструктор
# RichTextLabel
C#
public RichTextLabel();

Создаёт метку форматированного текста; добавьте её родителю через AddChild. Для разбора Text как BBCode включите BbcodeEnabled. Не открывает файлы или ссылки автоматически.

Свойства33

AutowrapModeСвойство
# AutowrapMode
C#
public TextServer.AutowrapMode AutowrapMode { get; set; }

Правило переноса по доступной ширине: отключение, произвольный перенос или перенос по словам. Меняет визуальные строки и размеры, сохраняя исходный Text. Для предсказуемого результата задайте метке ширину через компоновку.

AutowrapTrimFlagsСвойство
# AutowrapTrimFlags
C#
public TextServer.LineBreakFlag AutowrapTrimFlags { get; set; }

Флаги обработки краевых пробелов и отступа при переносе. Setter сохраняет только биты trim-маски TextServer; другие LineBreakFlag не включают здесь собственный режим переноса. Исходный текст не обрезается.

BbcodeEnabledСвойство
# BbcodeEnabled
C#
public bool BbcodeEnabled { get; set; }

Определяет разбор свойства Text как BBCode. Для ручного AddText разбор не включается; AppendText самостоятельно разбирает разметку. Переключение настройки не гарантирует перестройку вручную изменённого стека.

ContextMenuEnabledСвойство
# ContextMenuEnabled
C#
public bool ContextMenuEnabled { get; set; }

Разрешает открытие встроенного пользовательского меню. false не удаляет PopupMenu и не запрещает программные GetMenu/MenuOption. Это настройка интерфейса, а не запрет копирования данных приложением.

CustomEffectsСвойство
# CustomEffects
C#
public Reckfell.Collections.Array CustomEffects { get; set; }

Ресурсы пользовательских BBCode-эффектов. Setter заменяет массив и вызывает ReloadEffects; getter разделяет массив, поэтому изменение результата само по себе не перезапускает разбор. Эффекты с совпадающими именами неоднозначны: используется первое подходящее имя. Для прямого программного применения используйте PushCustomfx.

DeselectOnFocusLossEnabledСвойство
# DeselectOnFocusLossEnabled
C#
public bool DeselectOnFocusLossEnabled { get; set; }

Разрешает снятие выделения при потере фокуса. При переключении false → true у метки без фокуса существующее выделение снимается сразу. Для сохранения выделения при переходе к другому элементу используйте false.

DragAndDropSelectionEnabledСвойство
# DragAndDropSelectionEnabled
C#
public bool DragAndDropSelectionEnabled { get; set; }

Разрешает пользовательское перетаскивание выделенного обычного текста из метки. Нужно SelectionEnabled; не включает редактирование или приём произвольных файлов. Назначение свойства не запускает перенос.

FitContentСвойство
# FitContent
C#
public bool FitContent { get; set; }

Учитывает содержимое в минимальном размере метки. Родительский контейнер может расширить элемент; это не команда установить точный Size и не уменьшение шрифта. Учитывайте взаимодействие с переносами и ограничениями родителя.

HintUnderlinedСвойство
# HintUnderlined
C#
public bool HintUnderlined { get; set; }

Разрешает визуальное подчёркивание областей PushHint. Не включает или отключает само содержимое подсказки и не меняет текст.

HorizontalAlignmentСвойство
# HorizontalAlignment
C#
public HorizontalAlignment HorizontalAlignment { get; set; }

Выравнивание основного текста по горизонтали; локальная разметка абзаца может задавать своё. Fill использует JustificationFlags для выравнивания по ширине. Не перемещает сам Control в родительском контейнере.

JustificationFlagsСвойство
# JustificationFlags
C#
public TextServer.JustificationFlag JustificationFlags { get; set; }

Правила растяжения строк при выравнивании по ширине, например обработка слов и последней строки. Действуют вместе с соответствующим выравниванием; не задают ширину метки.

LanguageСвойство
# Language
C#
public string Language { get; set; }

Языковая подсказка текстовой системе для формирования и переноса. Не переводит строку на другой язык; перевод UI исходного Text — отдельный механизм.

MaximumFontSizeСвойство
# MaximumFontSize
C#
public int MaximumFontSize { get; set; }

Верхняя граница подбора при ResizeFontToFit. Согласуйте с MinimumFontSize; это ограничение подбора, а не общий запрет локальных размеров BBCode.

MetaUnderlinedСвойство
# MetaUnderlined
C#
public bool MetaUnderlined { get; set; }

Разрешает подчёркивание областей метаданных с учётом их MetaUnderline. Не создаёт ссылку и не открывает URL. Явная область PushUnderline остаётся отдельным форматированием.

MinimumFontSizeСвойство
# MinimumFontSize
C#
public int MinimumFontSize { get; set; }

Нижняя граница подбора при ResizeFontToFit. Задавайте положительное значение не больше MaximumFontSize. Само назначение не означает, что именно этот размер уже нарисован.

ProgressBarDelayСвойство
# ProgressBarDelay
C#
public int ProgressBarDelay { get; set; }

Задержка показа индикатора фоновой загрузки в миллисекундах. Положительное значение ждёт этот интервал; 0 и отрицательные значения отключают индикатор. Не задаёт скорость разбора или задержку появления символов.

ResizeFontToFitСвойство
# ResizeFontToFit
C#
public bool ResizeFontToFit { get; set; }

Разрешает подбирать размер основного шрифта для доступной области в диапазоне MinimumFontSize–MaximumFontSize. Не заменяет FitContent: здесь меняется шрифт, а не требование минимального размера. Подбор зависит от ширины и высоты; слишком маленький минимум не гарантирует читаемость.

ScrollActiveСвойство
# ScrollActive
C#
public bool ScrollActive { get; set; }

Разрешает встроенную вертикальную прокрутку. Переключение вызывает повторное применение исходного Text: при смешении с ручным AddText/Push содержимое может быть перестроено из сохранённой строки. Задавайте режим до ручного построения. Не означает, что всё содержимое помещается без полосы.

ScrollFollowingСвойство
# ScrollFollowing
C#
public bool ScrollFollowing { get; set; }

Разрешает следование за концом дополняемого текста. Если пользователь прокрутил вверх, фактическое следование может приостановиться до возвращения к низу. Getter сообщает настройку, а не факт положения внизу.

ScrollFollowingVisibleCharactersСвойство
# ScrollFollowingVisibleCharacters
C#
public bool ScrollFollowingVisibleCharacters { get; set; }

Прокручивает к области, раскрываемой через VisibleCharacters. Отличается от следования за полным концом текста: предназначено для постепенного показа. Назначение true может сразу изменить прокрутку.

SelectionEnabledСвойство
# SelectionEnabled
C#
public bool SelectionEnabled { get; set; }

Разрешает выделение отображаемого текста и SelectAll. Включение задаёт FocusMode.All; отключение снимает активное выделение и устанавливает режим фокуса доступности. Не делает метку редактируемой и не изменяет Text.

ShortcutKeysEnabledСвойство
# ShortcutKeysEnabled
C#
public bool ShortcutKeysEnabled { get; set; }

Разрешает встроенные сочетания команд метки. Не включает SelectionEnabled автоматически и не запрещает прямые программные вызовы SelectAll/MenuOption.

StructuredTextBidiOverrideСвойство
# StructuredTextBidiOverride
C#
public TextServer.StructuredTextParser StructuredTextBidiOverride { get; set; }

Выбирает разбор структурированного двунаправленного текста, например адресов и путей. Это настройка формирования, не regex-замена исходной строки. Параметры задаёт StructuredTextBidiOverrideOptions.

StructuredTextBidiOverrideOptionsСвойство
# StructuredTextBidiOverrideOptions
C#
public Reckfell.Collections.Array StructuredTextBidiOverrideOptions { get; set; }

Параметры структурированного BiDi-разбора. Массив сохраняется по общей ссылке; изменение его содержимого не запускает перерасчёт автоматически. Для обновления назначьте новый массив с отличающимся содержимым: равное содержимое setter может пропустить.

TabSizeСвойство
# TabSize
C#
public int TabSize { get; set; }

Ширина стандартного шага табуляции в пробелах; используйте положительное значение. Меняет отображение tab, не заменяет его пробелами в Text. Для явных позиций используйте TabStops.

TabStopsСвойство
# TabStops
C#
public float[] TabStops { get; set; }

Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.

TextСвойство
# Text
C#
public string Text { get; set; }

Исходная строка для полного построения метки, с переводом UI и разбором BBCode при включённом BbcodeEnabled. Назначение заменяет ручное содержимое; одинаковая непустая строка может ничего не перестроить. AddText, AppendText и Push-методы не дописывают сюда свой результат. Для получившегося обычного текста используйте GetParsedText.

TextDirectionСвойство
# TextDirection
C#
public Control.TextDirection TextDirection { get; set; }

Направление текста для BiDi-формирования. Не переставляет символы исходной строки вручную и не переводит текст. Разметка структурированного текста настраивается отдельно.

ThreadedСвойство
# Threaded
C#
public bool Threaded { get; set; }

Разрешает фоновый расчёт раскладки текста; по умолчанию false. Не делает произвольные вызовы RichTextLabel потокобезопасными и не переносит всю отрисовку в другой поток. Следите за IsFinished; до завершения метрики могут описывать только обработанную часть.

VerticalAlignmentСвойство
# VerticalAlignment
C#
public VerticalAlignment VerticalAlignment { get; set; }

Размещение текстового содержимого по вертикали внутри области метки. Не меняет вертикальное выравнивание Control у родителя и не включает автоматическую прокрутку.

VisibleCharactersСвойство
# VisibleCharacters
C#
public int VisibleCharacters { get; set; }

Лимит постепенного показа: -1 показывает всё, 0 скрывает текст, неотрицательное значение задаёт предел. Поведение до/после формирования глифов выбирает VisibleCharactersBehavior. Это не количество кадров и не UTF-16 Length строки Text. Setter пересчитывает VisibleRatio, но не ограничивает явно слишком большое значение; для анимации держите диапазон от 0 до GetTotalCharacterCount.

VisibleCharactersBehaviorСвойство
# VisibleCharactersBehavior
C#
public TextServer.VisibleCharactersBehavior VisibleCharactersBehavior { get; set; }

Определяет, применяется ли лимит до формирования текста или к уже сформированным символам/глифам. До формирования может меняться раскладка; после формирования сохраняется контекст полной строки, но единицы показа зависят от режима. Учитывайте лигатуры, составные символы и RTL; не предполагайте один char C# на один видимый глиф.

VisibleRatioСвойство
# VisibleRatio
C#
public float VisibleRatio { get; set; }

Доля показа: значения от 0 до 1 переводятся в целый VisibleCharacters с усечением. Значение от 1 показывает всё, отрицательное скрывает. Не создаёт таймер: увеличивайте долю из анимации приложения. Доля относится к счётчику содержимого, не обязательно к числу визуально отдельных букв.

Методы163

AddHrvoid
# AddHr
C#
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 не нужен.

Параметры
ИмяТипПо умолчанию
widthint90
heightint2
colorColor?default
alignmentHorizontalAlignmentHorizontalAlignment.Center
widthInPercentbooltrue
heightInPercentboolfalse
width

Неотрицательная ширина; по умолчанию 90 процентов.

height

Неотрицательная высота; Percent для изображений считается от доступной ширины текста.

color

Модуляция изображения или цвет соответствующего оформления.

alignment

Горизонтальное выравнивание разделителя.

widthInPercent

Выбирать проценты вместо пикселей по ширине.

heightInPercent

Выбирать проценты вместо пикселей по высоте; база процентов — ширина текста.

AddImage5 перегрузок
# AddImage · 1/5
C#
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 не нужен. В таблице сначала откройте ячейку.

Параметры
ИмяТипПо умолчанию
imageTexture2D—
widthint—
heightint—
colorColor?—
inlineAlignInlineAlignment—
regionRect2?—
image

Действительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.

width

Неотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.

height

Неотрицательная высота; Percent для изображений считается от доступной ширины текста.

color

Модуляция изображения или цвет соответствующего оформления.

inlineAlign

Выравнивание встроенного объекта относительно строки текста.

region

Область текстуры в пикселях; пустой Rect2 использует всю текстуру.

# AddImage · 2/5
C#
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 не нужен. В таблице сначала откройте ячейку.

Параметры
ИмяТипПо умолчанию
imageTexture2D—
widthint—
heightint—
colorColor?—
inlineAlignInlineAlignment—
regionRect2?—
keyVariant—
padbool—
tooltipstring—
sizeInPercentbool—
image

Действительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.

width

Неотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.

height

Неотрицательная высота; Percent для изображений считается от доступной ширины текста.

color

Модуляция изображения или цвет соответствующего оформления.

inlineAlign

Выравнивание встроенного объекта относительно строки текста.

region

Область текстуры в пикселях; пустой Rect2 использует всю текстуру.

key

Уникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.

pad

Центрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.

tooltip

Текст подсказки изображения.

sizeInPercent

В старой перегрузке true выбирает проценты для обеих осей.

# AddImage · 3/5
C#
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 не нужен. В таблице сначала откройте ячейку.

Параметры
ИмяТипПо умолчанию
imageTexture2D—
widthint—
heightint—
colorColor?—
inlineAlignInlineAlignment—
regionRect2?—
keyVariant—
padbool—
tooltipstring—
widthInPercentbool—
heightInPercentbool—
altTextstring—
image

Действительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.

width

Неотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.

height

Неотрицательная высота; Percent для изображений считается от доступной ширины текста.

color

Модуляция изображения или цвет соответствующего оформления.

inlineAlign

Выравнивание встроенного объекта относительно строки текста.

region

Область текстуры в пикселях; пустой Rect2 использует всю текстуру.

key

Уникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.

pad

Центрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.

tooltip

Текст подсказки изображения.

widthInPercent

Выбирать проценты вместо пикселей по ширине.

heightInPercent

Выбирать проценты вместо пикселей по высоте; база процентов — ширина текста.

altText

Описание изображения для вспомогательных технологий, не видимая подпись.

# AddImage · 4/5
C#
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 не нужен. В таблице сначала откройте ячейку.

Параметры
ИмяТипПо умолчанию
imageTexture2D—
widthint—
heightint—
colorColor?—
inlineAlignInlineAlignment—
regionRect2?—
keyVariant—
padbool—
tooltipstring—
sizeInPercentbool—
altTextstring—
image

Действительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.

width

Неотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.

height

Неотрицательная высота; Percent для изображений считается от доступной ширины текста.

color

Модуляция изображения или цвет соответствующего оформления.

inlineAlign

Выравнивание встроенного объекта относительно строки текста.

region

Область текстуры в пикселях; пустой Rect2 использует всю текстуру.

key

Уникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.

pad

Центрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.

tooltip

Текст подсказки изображения.

sizeInPercent

В старой перегрузке true выбирает проценты для обеих осей.

altText

Описание изображения для вспомогательных технологий, не видимая подпись.

# AddImage · 5/5
C#
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 не нужен. В таблице сначала откройте ячейку.

Параметры
ИмяТипПо умолчанию
imageTexture2D—
widthfloat0f
heightfloat0f
colorColor?default
inlineAlignInlineAlignmentInlineAlignment.Center
regionRect2?default
keyVariantdefault
padboolfalse
tooltipstring""
widthUnitRichTextLabel.ImageUnitRichTextLabel.ImageUnit.Pixel
heightUnitRichTextLabel.ImageUnitRichTextLabel.ImageUnit.Pixel
altTextstring""
image

Действительная Texture2D ненулевого размера; в UpdateImage обязательна при флаге Texture.

width

Неотрицательная ширина в выбранных единицах; 0 при AddImage — авто, при UpdateImage — сохранить прежнюю.

height

Неотрицательная высота; Percent для изображений считается от доступной ширины текста.

color

Модуляция изображения или цвет соответствующего оформления.

inlineAlign

Выравнивание встроенного объекта относительно строки текста.

region

Область текстуры в пикселях; пустой Rect2 использует всю текстуру.

key

Уникальный Variant-ключ для обновления. Одинаковый ключ меняет все совпадения; nil может совпасть с объектами без явного ключа.

pad

Центрировать изображение в занятой области без увеличения сверх естественного размера вместо растяжения.

tooltip

Текст подсказки изображения.

widthUnit

Pixel, Percent или Em для ширины; в UpdateImage применяется через маску WidthUnit.

heightUnit

Единицы высоты; Percent использует ширину области, Em умножает размер шрифта.

altText

Описание изображения для вспомогательных технологий, не видимая подпись.

AddTextvoid
# AddText
C#
public void AddText(string text);

Добавляет буквальный текст в текущую область форматирования. Теги в квадратных скобках не разбираются. Подходит для пользовательского текста внутри Push/Pop без интерпретации его как разметки. Не обновляет свойство Text; прямо внутрь таблицы текст не добавляется — нужна ячейка.

Параметры
ИмяТипПо умолчанию
textstring—
text

Исходный или буквальный текст в зависимости от метода; AddText не разбирает теги.

AppendTextvoid
# AppendText
C#
public void AppendText(string bbcode);

Разбирает фрагмент BBCode и добавляет форматированное содержимое без полного сброса. Не дописывает фрагмент в свойство Text. Для данных, которые должны отображаться буквально, используйте AddText. Держите пары тегов согласованными; для программных областей удобнее Push/Pop.

Параметры
ИмяТипПо умолчанию
bbcodestring—
bbcode

Фрагмент BBCode для разбора, не буквальный текст.

Clearvoid
# Clear
C#
public void Clear();

Удаляет построенное содержимое и области форматирования, сбрасывает выделение и эффекты текущего текста. Сохранённая исходная строка Text остаётся; для её очистки назначьте Text = "". Не очищает список зарегистрированных CustomEffects.

Deselectvoid
# Deselect
C#
public void Deselect();

Снимает текущее выделение без изменения текста, прокрутки или разрешения SelectionEnabled.

GetAutowrapModeTextServer.AutowrapMode
# GetAutowrapMode
C#
public TextServer.AutowrapMode GetAutowrapMode();

Правило переноса по доступной ширине: отключение, произвольный перенос или перенос по словам. Меняет визуальные строки и размеры, сохраняя исходный Text. Для предсказуемого результата задайте метке ширину через компоновку.

Возвращает TextServer.AutowrapMode

Правило переноса по доступной ширине: отключение, произвольный перенос или перенос по словам. Меняет визуальные строки и размеры, сохраняя исходный Text. Для предсказуемого результата задайте метке ширину через компоновку.

GetAutowrapTrimFlagsTextServer.LineBreakFlag
# GetAutowrapTrimFlags
C#
public TextServer.LineBreakFlag GetAutowrapTrimFlags();

Флаги обработки краевых пробелов и отступа при переносе. Setter сохраняет только биты trim-маски TextServer; другие LineBreakFlag не включают здесь собственный режим переноса. Исходный текст не обрезается.

Возвращает TextServer.LineBreakFlag

Флаги обработки краевых пробелов и отступа при переносе. Setter сохраняет только биты trim-маски TextServer; другие LineBreakFlag не включают здесь собственный режим переноса. Исходный текст не обрезается.

GetCharacterLineint
# GetCharacterLine
C#
public int GetCharacterLine(int character);

Возвращает индекс визуальной строки переноса, содержащей позицию содержимого, либо -1, если она не найдена среди рассчитанных данных. Индекс символа не является смещением в исходном BBCode или UTF-16. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

Параметры
ИмяТипПо умолчанию
characterint—
character

Позиция в содержимом без тегов, не UTF-16-индекс исходного Text.

Возвращает int

Возвращает индекс визуальной строки переноса, содержащей позицию содержимого, либо -1, если она не найдена среди рассчитанных данных. Индекс символа не является смещением в исходном BBCode или UTF-16. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

GetCharacterParagraphint
# GetCharacterParagraph
C#
public int GetCharacterParagraph(int character);

Возвращает индекс абзаца для позиции содержимого либо -1. Абзац может содержать несколько строк переноса. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

Параметры
ИмяТипПо умолчанию
characterint—
character

Позиция в содержимом без тегов, не UTF-16-индекс исходного Text.

Возвращает int

Возвращает индекс абзаца для позиции содержимого либо -1. Абзац может содержать несколько строк переноса. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

GetContentHeightint
# GetContentHeight
C#
public int GetContentHeight();

Высота рассчитанного содержимого в пикселях с интервалами темы. Это не высота видимого окна прокрутки. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

Возвращает int

Высота рассчитанного содержимого в пикселях с интервалами темы. Это не высота видимого окна прокрутки. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

GetContentWidthint
# GetContentWidth
C#
public int GetContentWidth();

Ширина рассчитанного содержимого в пикселях элемента, а не ограничение размера Control. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

Возвращает int

Ширина рассчитанного содержимого в пикселях элемента, а не ограничение размера Control. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

GetEffectsReckfell.Collections.Array
# GetEffects
C#
public Reckfell.Collections.Array GetEffects();

Ресурсы пользовательских BBCode-эффектов. Setter заменяет массив и вызывает ReloadEffects; getter разделяет массив, поэтому изменение результата само по себе не перезапускает разбор. Эффекты с совпадающими именами неоднозначны: используется первое подходящее имя. Для прямого программного применения используйте PushCustomfx.

Возвращает Reckfell.Collections.Array

Ресурсы пользовательских BBCode-эффектов. Setter заменяет массив и вызывает ReloadEffects; getter разделяет массив, поэтому изменение результата само по себе не перезапускает разбор. Эффекты с совпадающими именами неоднозначны: используется первое подходящее имя. Для прямого программного применения используйте PushCustomfx.

GetHorizontalAlignmentHorizontalAlignment
# GetHorizontalAlignment
C#
public HorizontalAlignment GetHorizontalAlignment();

Выравнивание основного текста по горизонтали; локальная разметка абзаца может задавать своё. Fill использует JustificationFlags для выравнивания по ширине. Не перемещает сам Control в родительском контейнере.

Возвращает HorizontalAlignment

Выравнивание основного текста по горизонтали; локальная разметка абзаца может задавать своё. Fill использует JustificationFlags для выравнивания по ширине. Не перемещает сам Control в родительском контейнере.

GetJustificationFlagsTextServer.JustificationFlag
# GetJustificationFlags
C#
public TextServer.JustificationFlag GetJustificationFlags();

Правила растяжения строк при выравнивании по ширине, например обработка слов и последней строки. Действуют вместе с соответствующим выравниванием; не задают ширину метки.

Возвращает TextServer.JustificationFlag

Правила растяжения строк при выравнивании по ширине, например обработка слов и последней строки. Действуют вместе с соответствующим выравниванием; не задают ширину метки.

GetLanguagestring
# GetLanguage
C#
public string GetLanguage();

Языковая подсказка текстовой системе для формирования и переноса. Не переводит строку на другой язык; перевод UI исходного Text — отдельный механизм.

Возвращает string

Языковая подсказка текстовой системе для формирования и переноса. Не переводит строку на другой язык; перевод UI исходного Text — отдельный механизм.

GetLineCountint
# GetLineCount
C#
public int GetLineCount();

Число рассчитанных визуальных строк основного потока, включая переносы. В отличие от TextEdit это не число логических строк файла. Зависит от ширины, шрифта и режима показа. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

Возвращает int

Число рассчитанных визуальных строк основного потока, включая переносы. В отличие от TextEdit это не число логических строк файла. Зависит от ширины, шрифта и режима показа. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

GetLineHeightint
# GetLineHeight
C#
public int GetLineHeight(int line);

Высота визуальной строки: ascent + descent + интервал строк темы. Может отличаться между строками из-за форматирования. Передавайте существующий индекс. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

Параметры
ИмяТипПо умолчанию
lineint—
line

Индекс визуальной строки переноса от 0.

Возвращает int

Высота визуальной строки: ascent + descent + интервал строк темы. Может отличаться между строками из-за форматирования. Передавайте существующий индекс. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

GetLineOffsetfloat
# GetLineOffset
C#
public float GetLineOffset(int line);

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

Параметры
ИмяТипПо умолчанию
lineint—
line

Индекс визуальной строки переноса от 0.

Возвращает float

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

GetLineRangeVector2I
# GetLineRange
C#
public Vector2I GetLineRange(int line);

Диапазон позиций содержимого для рассчитанной визуальной строки: X — начало, Y — конец. Не диапазон исходной BBCode-строки или индексов UTF-16. Сначала проверьте 0 <= line < GetLineCount; (0, 0) не является надёжным признаком ошибки. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

Параметры
ИмяТипПо умолчанию
lineint—
line

Индекс визуальной строки переноса от 0.

Возвращает Vector2I

Диапазон позиций содержимого для рассчитанной визуальной строки: X — начало, Y — конец. Не диапазон исходной BBCode-строки или индексов UTF-16. Сначала проверьте 0 <= line < GetLineCount; (0, 0) не является надёжным признаком ошибки. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

GetLineWidthint
# GetLineWidth
C#
public int GetLineWidth(int line);

Ширина существующей рассчитанной визуальной строки в пикселях. Передавайте индекс от 0 до GetLineCount() - 1, не номер абзаца. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

Параметры
ИмяТипПо умолчанию
lineint—
line

Индекс визуальной строки переноса от 0.

Возвращает int

Ширина существующей рассчитанной визуальной строки в пикселях. Передавайте индекс от 0 до GetLineCount() - 1, не номер абзаца. При Threaded итоговые размеры считывайте после IsFinished; изменение текста, ширины или шрифта снова делает данные неготовыми.

GetMaximumFontSizeint
# GetMaximumFontSize
C#
public int GetMaximumFontSize();

Верхняя граница подбора при ResizeFontToFit. Согласуйте с MinimumFontSize; это ограничение подбора, а не общий запрет локальных размеров BBCode.

Возвращает int

Верхняя граница подбора при ResizeFontToFit. Согласуйте с MinimumFontSize; это ограничение подбора, а не общий запрет локальных размеров BBCode.

GetMenuPopupMenu
# GetMenu
C#
public PopupMenu GetMenu();

Возвращает встроенный PopupMenu, создавая его при первом обращении без показа. Меню принадлежит метке и удаляется вместе с ней; не вызывайте Free/Dispose для этой заимствованной ссылки.

Возвращает PopupMenu

Возвращает встроенный PopupMenu, создавая его при первом обращении без показа. Меню принадлежит метке и удаляется вместе с ней; не вызывайте Free/Dispose для этой заимствованной ссылки.

GetMinimumFontSizeint
# GetMinimumFontSize
C#
public int GetMinimumFontSize();

Нижняя граница подбора при ResizeFontToFit. Задавайте положительное значение не больше MaximumFontSize. Само назначение не означает, что именно этот размер уже нарисован.

Возвращает int

Нижняя граница подбора при ResizeFontToFit. Задавайте положительное значение не больше MaximumFontSize. Само назначение не означает, что именно этот размер уже нарисован.

GetParagraphCountint
# GetParagraphCount
C#
public int GetParagraphCount();

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

Возвращает int

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

GetParagraphOffsetfloat
# GetParagraphOffset
C#
public float GetParagraphOffset(int paragraph);

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

Параметры
ИмяТипПо умолчанию
paragraphint—
paragraph

Индекс абзаца основного потока от 0.

Возвращает float

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

GetParsedTextstring
# GetParsedText
C#
public string GetParsedText();

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

Возвращает string

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

GetProgressBarDelayint
# GetProgressBarDelay
C#
public int GetProgressBarDelay();

Задержка показа индикатора фоновой загрузки в миллисекундах. Положительное значение ждёт этот интервал; 0 и отрицательные значения отключают индикатор. Не задаёт скорость разбора или задержку появления символов.

Возвращает int

Задержка показа индикатора фоновой загрузки в миллисекундах. Положительное значение ждёт этот интервал; 0 и отрицательные значения отключают индикатор. Не задаёт скорость разбора или задержку появления символов.

GetRenderedFontSizeint
# GetRenderedFontSize
C#
public int GetRenderedFontSize();

Текущее вычисленное значение подбора основного шрифта. Не описывает каждый локально форматированный фрагмент. При отключении подбора кэш сбрасывается в 0; не используйте 0 как реальный размер для создания другого шрифта.

Возвращает int

Текущее вычисленное значение подбора основного шрифта. Не описывает каждый локально форматированный фрагмент. При отключении подбора кэш сбрасывается в 0; не используйте 0 как реальный размер для создания другого шрифта.

GetSelectedTextstring
# GetSelectedText
C#
public string GetSelectedText();

Возвращает выделенный обычный текст без тегов, либо пустую строку при отсутствии/запрете выделения. Встроенные изображения представлены пробелами; таблицы обходятся как содержимое. Это не срез исходного Text с BBCode.

Возвращает string

Возвращает выделенный обычный текст без тегов, либо пустую строку при отсутствии/запрете выделения. Встроенные изображения представлены пробелами; таблицы обходятся как содержимое. Это не срез исходного Text с BBCode.

GetSelectionFromint
# GetSelectionFrom
C#
public int GetSelectionFrom();

Возвращает начальную позицию активного выделения в модели содержимого или -1. Не является индексом в исходной BBCode-строке или UTF-16; для получения текста используйте GetSelectedText, особенно при таблицах и встроенных объектах.

Возвращает int

Возвращает начальную позицию активного выделения в модели содержимого или -1. Не является индексом в исходной BBCode-строке или UTF-16; для получения текста используйте GetSelectedText, особенно при таблицах и встроенных объектах.

GetSelectionLineOffsetfloat
# GetSelectionLineOffset
C#
public float GetSelectionLineOffset();

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

Возвращает float

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

GetSelectionToint
# GetSelectionTo
C#
public int GetSelectionTo();

Возвращает включённую конечную позицию активного выделения или -1. Для обычного диапазона содержимого длина равна to - from + 1; это не исключённая граница TextEdit. Не используйте напрямую как индекс среза исходной строки C#.

Возвращает int

Возвращает включённую конечную позицию активного выделения или -1. Для обычного диапазона содержимого длина равна to - from + 1; это не исключённая граница TextEdit. Не используйте напрямую как индекс среза исходной строки C#.

GetStructuredTextBidiOverrideTextServer.StructuredTextParser
# GetStructuredTextBidiOverride
C#
public TextServer.StructuredTextParser GetStructuredTextBidiOverride();

Выбирает разбор структурированного двунаправленного текста, например адресов и путей. Это настройка формирования, не regex-замена исходной строки. Параметры задаёт StructuredTextBidiOverrideOptions.

Возвращает TextServer.StructuredTextParser

Выбирает разбор структурированного двунаправленного текста, например адресов и путей. Это настройка формирования, не regex-замена исходной строки. Параметры задаёт StructuredTextBidiOverrideOptions.

GetStructuredTextBidiOverrideOptionsReckfell.Collections.Array
# GetStructuredTextBidiOverrideOptions
C#
public Reckfell.Collections.Array GetStructuredTextBidiOverrideOptions();

Параметры структурированного BiDi-разбора. Массив сохраняется по общей ссылке; изменение его содержимого не запускает перерасчёт автоматически. Для обновления назначьте новый массив с отличающимся содержимым: равное содержимое setter может пропустить.

Возвращает Reckfell.Collections.Array

Параметры структурированного BiDi-разбора. Массив сохраняется по общей ссылке; изменение его содержимого не запускает перерасчёт автоматически. Для обновления назначьте новый массив с отличающимся содержимым: равное содержимое setter может пропустить.

GetTabSizeint
# GetTabSize
C#
public int GetTabSize();

Ширина стандартного шага табуляции в пробелах; используйте положительное значение. Меняет отображение tab, не заменяет его пробелами в Text. Для явных позиций используйте TabStops.

Возвращает int

Ширина стандартного шага табуляции в пробелах; используйте положительное значение. Меняет отображение tab, не заменяет его пробелами в Text. Для явных позиций используйте TabStops.

GetTabStopsfloat[]
# GetTabStops
C#
public float[] GetTabStops();

Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.

Возвращает float[]

Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.

GetTextstring
# GetText
C#
public string GetText();

Исходная строка для полного построения метки, с переводом UI и разбором BBCode при включённом BbcodeEnabled. Назначение заменяет ручное содержимое; одинаковая непустая строка может ничего не перестроить. AddText, AppendText и Push-методы не дописывают сюда свой результат. Для получившегося обычного текста используйте GetParsedText.

Возвращает string

Исходная строка для полного построения метки, с переводом UI и разбором BBCode при включённом BbcodeEnabled. Назначение заменяет ручное содержимое; одинаковая непустая строка может ничего не перестроить. AddText, AppendText и Push-методы не дописывают сюда свой результат. Для получившегося обычного текста используйте GetParsedText.

GetTextDirectionControl.TextDirection
# GetTextDirection
C#
public Control.TextDirection GetTextDirection();

Направление текста для BiDi-формирования. Не переставляет символы исходной строки вручную и не переводит текст. Разметка структурированного текста настраивается отдельно.

Возвращает Control.TextDirection

Направление текста для BiDi-формирования. Не переставляет символы исходной строки вручную и не переводит текст. Разметка структурированного текста настраивается отдельно.

GetTotalCharacterCountint
# GetTotalCharacterCount
C#
public int GetTotalCharacterCount();

Считает содержимое без BBCode-тегов: текстовые кодовые точки, переводы строк и по одной позиции на встроенное изображение. Это не Text.Length, не число глифов и не количество уже видимых букв. Используйте как предел раскрытия, а не индекс среза исходной BBCode-строки.

Возвращает int

Считает содержимое без BBCode-тегов: текстовые кодовые точки, переводы строк и по одной позиции на встроенное изображение. Это не Text.Length, не число глифов и не количество уже видимых букв. Используйте как предел раскрытия, а не индекс среза исходной BBCode-строки.

GetVScrollBarVScrollBar
# GetVScrollBar
C#
public VScrollBar GetVScrollBar();

Возвращает встроенный VScrollBar, принадлежащий метке. Не освобождайте его через Free/Dispose и не переподчиняйте другому родителю. Значение измеряется в пикселях содержимого; доступный диапазон учитывает страницу полосы.

Возвращает VScrollBar

Возвращает встроенный VScrollBar, принадлежащий метке. Не освобождайте его через Free/Dispose и не переподчиняйте другому родителю. Значение измеряется в пикселях содержимого; доступный диапазон учитывает страницу полосы.

GetVerticalAlignmentVerticalAlignment
# GetVerticalAlignment
C#
public VerticalAlignment GetVerticalAlignment();

Размещение текстового содержимого по вертикали внутри области метки. Не меняет вертикальное выравнивание Control у родителя и не включает автоматическую прокрутку.

Возвращает VerticalAlignment

Размещение текстового содержимого по вертикали внутри области метки. Не меняет вертикальное выравнивание Control у родителя и не включает автоматическую прокрутку.

GetVisibleCharactersint
# GetVisibleCharacters
C#
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
# GetVisibleCharactersBehavior
C#
public TextServer.VisibleCharactersBehavior GetVisibleCharactersBehavior();

Определяет, применяется ли лимит до формирования текста или к уже сформированным символам/глифам. До формирования может меняться раскладка; после формирования сохраняется контекст полной строки, но единицы показа зависят от режима. Учитывайте лигатуры, составные символы и RTL; не предполагайте один char C# на один видимый глиф.

Возвращает TextServer.VisibleCharactersBehavior

Определяет, применяется ли лимит до формирования текста или к уже сформированным символам/глифам. До формирования может меняться раскладка; после формирования сохраняется контекст полной строки, но единицы показа зависят от режима. Учитывайте лигатуры, составные символы и RTL; не предполагайте один char C# на один видимый глиф.

GetVisibleContentRectRect2I
# GetVisibleContentRect
C#
public Rect2I GetVisibleContentRect();

Кэшированный прямоугольник нарисованного видимого содержимого в координатах метки. Не размер всего текста и не экранный прямоугольник. До актуальной отрисовки может быть пустым или относиться к прежнему кадру; один IsFinished не обновляет этот кэш.

Возвращает Rect2I

Кэшированный прямоугольник нарисованного видимого содержимого в координатах метки. Не размер всего текста и не экранный прямоугольник. До актуальной отрисовки может быть пустым или относиться к прежнему кадру; один IsFinished не обновляет этот кэш.

GetVisibleLineCountint
# GetVisibleLineCount
C#
public int GetVisibleLineCount();

Число видимых строк из результатов отрисовки. Это не вместимость окна по высоте и не общее GetLineCount. При Visible = false возвращает 0; сразу после изменения текста или размера дождитесь актуального кадра. IsFinished подтверждает расчёт, но не наличие нового кадра.

Возвращает int

Число видимых строк из результатов отрисовки. Это не вместимость окна по высоте и не общее GetLineCount. При Visible = false возвращает 0; сразу после изменения текста или размера дождитесь актуального кадра. IsFinished подтверждает расчёт, но не наличие нового кадра.

GetVisibleParagraphCountint
# GetVisibleParagraphCount
C#
public int GetVisibleParagraphCount();

Число видимых абзацев по результатам отрисовки, не число строк переноса. Для актуального результата нужен кадр после изменения содержимого/прокрутки; при Visible = false возвращает 0.

Возвращает int

Число видимых абзацев по результатам отрисовки, не число строк переноса. Для актуального результата нужен кадр после изменения содержимого/прокрутки; при Visible = false возвращает 0.

GetVisibleRatiofloat
# GetVisibleRatio
C#
public float GetVisibleRatio();

Доля показа: значения от 0 до 1 переводятся в целый VisibleCharacters с усечением. Значение от 1 показывает всё, отрицательное скрывает. Не создаёт таймер: увеличивайте долю из анимации приложения. Доля относится к счётчику содержимого, не обязательно к числу визуально отдельных букв.

Возвращает float

Доля показа: значения от 0 до 1 переводятся в целый VisibleCharacters с усечением. Значение от 1 показывает всё, отрицательное скрывает. Не создаёт таймер: увеличивайте долю из анимации приложения. Доля относится к счётчику содержимого, не обязательно к числу визуально отдельных букв.

InstallEffectvoid
# InstallEffect
C#
public void InstallEffect(Variant effect);

Добавляет ресурс RichTextEffect к зарегистрированным эффектам и вызывает ReloadEffects. Не заменяет автоматически существующий ресурс с тем же именем тега. Имя BBCode определяется скриптом эффекта; для обхода поиска имени применяйте PushCustomfx.

Параметры
ИмяТипПо умолчанию
effectVariant—
effect

Действительный ресурс RichTextEffect.

InvalidateParagraphbool
# InvalidateParagraph
C#
public bool InvalidateParagraph(int paragraph);

Помечает расчёт формы, размера и шрифта начиная с указанного абзаца как устаревший. Не удаляет абзац, не меняет Text и не выполняет полный разбор BBCode. true означает принятый индекс, а не завершение пересчёта; проверяйте IsFinished отдельно.

Параметры
ИмяТипПо умолчанию
paragraphint—
paragraph

Индекс абзаца основного потока от 0 до GetParagraphCount() - 1.

Возвращает bool

Помечает расчёт формы, размера и шрифта начиная с указанного абзаца как устаревший. Не удаляет абзац, не меняет Text и не выполняет полный разбор BBCode. true означает принятый индекс, а не завершение пересчёта; проверяйте IsFinished отдельно.

IsContextMenuEnabledbool
# IsContextMenuEnabled
C#
public bool IsContextMenuEnabled();

Разрешает открытие встроенного пользовательского меню. false не удаляет PopupMenu и не запрещает программные GetMenu/MenuOption. Это настройка интерфейса, а не запрет копирования данных приложением.

Возвращает bool

Разрешает открытие встроенного пользовательского меню. false не удаляет PopupMenu и не запрещает программные GetMenu/MenuOption. Это настройка интерфейса, а не запрет копирования данных приложением.

IsDeselectOnFocusLossEnabledbool
# IsDeselectOnFocusLossEnabled
C#
public bool IsDeselectOnFocusLossEnabled();

Разрешает снятие выделения при потере фокуса. При переключении false → true у метки без фокуса существующее выделение снимается сразу. Для сохранения выделения при переходе к другому элементу используйте false.

Возвращает bool

Разрешает снятие выделения при потере фокуса. При переключении false → true у метки без фокуса существующее выделение снимается сразу. Для сохранения выделения при переходе к другому элементу используйте false.

IsDragAndDropSelectionEnabledbool
# IsDragAndDropSelectionEnabled
C#
public bool IsDragAndDropSelectionEnabled();

Разрешает пользовательское перетаскивание выделенного обычного текста из метки. Нужно SelectionEnabled; не включает редактирование или приём произвольных файлов. Назначение свойства не запускает перенос.

Возвращает bool

Разрешает пользовательское перетаскивание выделенного обычного текста из метки. Нужно SelectionEnabled; не включает редактирование или приём произвольных файлов. Назначение свойства не запускает перенос.

IsFinishedbool
# IsFinished
C#
public bool IsFinished();

Проверяет завершённость текущих расчётов формы, размера и шрифтов. Проверка сама может запустить обновление кэшей; это не ожидание блокировкой и не признак завершения анимации VisibleCharacters. Подписываясь на Finished, учитывайте, что текст уже мог быть готов.

Возвращает bool

Проверяет завершённость текущих расчётов формы, размера и шрифтов. Проверка сама может запустить обновление кэшей; это не ожидание блокировкой и не признак завершения анимации VisibleCharacters. Подписываясь на Finished, учитывайте, что текст уже мог быть готов.

IsFitContentEnabledbool
# IsFitContentEnabled
C#
public bool IsFitContentEnabled();

Учитывает содержимое в минимальном размере метки. Родительский контейнер может расширить элемент; это не команда установить точный Size и не уменьшение шрифта. Учитывайте взаимодействие с переносами и ограничениями родителя.

Возвращает bool

Учитывает содержимое в минимальном размере метки. Родительский контейнер может расширить элемент; это не команда установить точный Size и не уменьшение шрифта. Учитывайте взаимодействие с переносами и ограничениями родителя.

IsHintUnderlinedbool
# IsHintUnderlined
C#
public bool IsHintUnderlined();

Разрешает визуальное подчёркивание областей PushHint. Не включает или отключает само содержимое подсказки и не меняет текст.

Возвращает bool

Разрешает визуальное подчёркивание областей PushHint. Не включает или отключает само содержимое подсказки и не меняет текст.

IsMenuVisiblebool
# IsMenuVisible
C#
public bool IsMenuVisible();

Проверяет фактическую видимость уже созданного меню, не создавая его. false до создания не означает, что ContextMenuEnabled выключен.

Возвращает bool

Проверяет фактическую видимость уже созданного меню, не создавая его. false до создания не означает, что ContextMenuEnabled выключен.

IsMetaUnderlinedbool
# IsMetaUnderlined
C#
public bool IsMetaUnderlined();

Разрешает подчёркивание областей метаданных с учётом их MetaUnderline. Не создаёт ссылку и не открывает URL. Явная область PushUnderline остаётся отдельным форматированием.

Возвращает bool

Разрешает подчёркивание областей метаданных с учётом их MetaUnderline. Не создаёт ссылку и не открывает URL. Явная область PushUnderline остаётся отдельным форматированием.

IsReadybool · Устарело
# IsReady
C#
public bool IsReady();

Устаревший псевдоним IsFinished. Используйте IsFinished; это готовность раскладки, не готовность сущности к работе и не сигнал входа в дерево.

Возвращает bool

Устаревший псевдоним IsFinished. Используйте IsFinished; это готовность раскладки, не готовность сущности к работе и не сигнал входа в дерево.

IsResizeFontToFitEnabledbool
# IsResizeFontToFitEnabled
C#
public bool IsResizeFontToFitEnabled();

Разрешает подбирать размер основного шрифта для доступной области в диапазоне MinimumFontSize–MaximumFontSize. Не заменяет FitContent: здесь меняется шрифт, а не требование минимального размера. Подбор зависит от ширины и высоты; слишком маленький минимум не гарантирует читаемость.

Возвращает bool

Разрешает подбирать размер основного шрифта для доступной области в диапазоне MinimumFontSize–MaximumFontSize. Не заменяет FitContent: здесь меняется шрифт, а не требование минимального размера. Подбор зависит от ширины и высоты; слишком маленький минимум не гарантирует читаемость.

IsScrollActivebool
# IsScrollActive
C#
public bool IsScrollActive();

Разрешает встроенную вертикальную прокрутку. Переключение вызывает повторное применение исходного Text: при смешении с ручным AddText/Push содержимое может быть перестроено из сохранённой строки. Задавайте режим до ручного построения. Не означает, что всё содержимое помещается без полосы.

Возвращает bool

Разрешает встроенную вертикальную прокрутку. Переключение вызывает повторное применение исходного Text: при смешении с ручным AddText/Push содержимое может быть перестроено из сохранённой строки. Задавайте режим до ручного построения. Не означает, что всё содержимое помещается без полосы.

IsScrollFollowingbool
# IsScrollFollowing
C#
public bool IsScrollFollowing();

Разрешает следование за концом дополняемого текста. Если пользователь прокрутил вверх, фактическое следование может приостановиться до возвращения к низу. Getter сообщает настройку, а не факт положения внизу.

Возвращает bool

Разрешает следование за концом дополняемого текста. Если пользователь прокрутил вверх, фактическое следование может приостановиться до возвращения к низу. Getter сообщает настройку, а не факт положения внизу.

IsScrollFollowingVisibleCharactersbool
# IsScrollFollowingVisibleCharacters
C#
public bool IsScrollFollowingVisibleCharacters();

Прокручивает к области, раскрываемой через VisibleCharacters. Отличается от следования за полным концом текста: предназначено для постепенного показа. Назначение true может сразу изменить прокрутку.

Возвращает bool

Прокручивает к области, раскрываемой через VisibleCharacters. Отличается от следования за полным концом текста: предназначено для постепенного показа. Назначение true может сразу изменить прокрутку.

IsSelectionEnabledbool
# IsSelectionEnabled
C#
public bool IsSelectionEnabled();

Разрешает выделение отображаемого текста и SelectAll. Включение задаёт FocusMode.All; отключение снимает активное выделение и устанавливает режим фокуса доступности. Не делает метку редактируемой и не изменяет Text.

Возвращает bool

Разрешает выделение отображаемого текста и SelectAll. Включение задаёт FocusMode.All; отключение снимает активное выделение и устанавливает режим фокуса доступности. Не делает метку редактируемой и не изменяет Text.

IsShortcutKeysEnabledbool
# IsShortcutKeysEnabled
C#
public bool IsShortcutKeysEnabled();

Разрешает встроенные сочетания команд метки. Не включает SelectionEnabled автоматически и не запрещает прямые программные вызовы SelectAll/MenuOption.

Возвращает bool

Разрешает встроенные сочетания команд метки. Не включает SelectionEnabled автоматически и не запрещает прямые программные вызовы SelectAll/MenuOption.

IsThreadedbool
# IsThreaded
C#
public bool IsThreaded();

Разрешает фоновый расчёт раскладки текста; по умолчанию false. Не делает произвольные вызовы RichTextLabel потокобезопасными и не переносит всю отрисовку в другой поток. Следите за IsFinished; до завершения метрики могут описывать только обработанную часть.

Возвращает bool

Разрешает фоновый расчёт раскладки текста; по умолчанию false. Не делает произвольные вызовы RichTextLabel потокобезопасными и не переносит всю отрисовку в другой поток. Следите за IsFinished; до завершения метрики могут описывать только обработанную часть.

IsUsingBbcodebool
# IsUsingBbcode
C#
public bool IsUsingBbcode();

Определяет разбор свойства Text как BBCode. Для ручного AddText разбор не включается; AppendText самостоятельно разбирает разметку. Переключение настройки не гарантирует перестройку вручную изменённого стека.

Возвращает bool

Определяет разбор свойства Text как BBCode. Для ручного AddText разбор не включается; AppendText самостоятельно разбирает разметку. Переключение настройки не гарантирует перестройку вручную изменённого стека.

MenuOptionvoid
# MenuOption
C#
public void MenuOption(int option);

Выполняет команду по ID MenuItems как int, не по индексу строки меню. Copy копирует выделение, а при пустом выделении — весь GetParsedText, даже если SelectionEnabled выключен. SelectAll требует разрешённого выделения. Не открывает меню; ContextMenuEnabled не блокирует прямой вызов.

Параметры
ИмяТипПо умолчанию
optionint—
option

Числовой ID команды MenuItems, не индекс PopupMenu.

Newlinevoid
# Newline
C#
public void Newline();

Добавляет явный перевод строки в текущее построенное содержимое и начинает следующий абзац текущей рамки. Не обновляет исходное свойство Text; не является автоматическим переносом по ширине.

ParseBbcodevoid
# ParseBbcode
C#
public void ParseBbcode(string bbcode);

Очищает текущее отображаемое содержимое и разбирает переданную разметку. Это полный разбор вместо дополнения AppendText. Не присваивает свойство Text; для хранения исходной строки назначайте Text при включённом BbcodeEnabled.

Параметры
ИмяТипПо умолчанию
bbcodestring—
bbcode

Фрагмент BBCode для разбора, не буквальный текст.

ParseExpressionsForValues2 перегрузки
# ParseExpressionsForValues · 1/2
C#
public Reckfell.Collections.Dictionary ParseExpressionsForValues(ReadOnlySpan<string> expressions);

Разбирает параметры вида key=value, не выполняя код или математические выражения. Распознаёт точные true/false, числа, #RGB/#RRGGBB и $path как EntityPath; другие значения остаются строками. Несколько значений через запятую становятся Array. При неверном числе знаков = возвращает уже накопленный частичный Dictionary. Array и Span перегрузки используют один разбор; не рассчитывайте на автоматическое удаление произвольных пробелов.

Параметры
ИмяТипПо умолчанию
expressionsReadOnlySpan<string>—
expressions

Параметры key=value; запятая разделяет значения.

Возвращает Reckfell.Collections.Dictionary

Разбирает параметры вида key=value, не выполняя код или математические выражения. Распознаёт точные true/false, числа, #RGB/#RRGGBB и $path как EntityPath; другие значения остаются строками. Несколько значений через запятую становятся Array. При неверном числе знаков = возвращает уже накопленный частичный Dictionary. Array и Span перегрузки используют один разбор; не рассчитывайте на автоматическое удаление произвольных пробелов.

# ParseExpressionsForValues · 2/2
C#
public Reckfell.Collections.Dictionary ParseExpressionsForValues(string[] expressions);

Разбирает параметры вида key=value, не выполняя код или математические выражения. Распознаёт точные true/false, числа, #RGB/#RRGGBB и $path как EntityPath; другие значения остаются строками. Несколько значений через запятую становятся Array. При неверном числе знаков = возвращает уже накопленный частичный Dictionary. Array и Span перегрузки используют один разбор; не рассчитывайте на автоматическое удаление произвольных пробелов.

Параметры
ИмяТипПо умолчанию
expressionsstring[]—
expressions

Параметры key=value; запятая разделяет значения.

Возвращает Reckfell.Collections.Dictionary

Разбирает параметры вида key=value, не выполняя код или математические выражения. Распознаёт точные true/false, числа, #RGB/#RRGGBB и $path как EntityPath; другие значения остаются строками. Несколько значений через запятую становятся Array. При неверном числе знаков = возвращает уже накопленный частичный Dictionary. Array и Span перегрузки используют один разбор; не рассчитывайте на автоматическое удаление произвольных пробелов.

Popvoid
# Pop
C#
public void Pop();

Закрывает одну текущую область форматирования, сохраняя её содержимое. Вызывайте только после соответствующего Push: у корневого уровня нет родителя. Не удаляет последний символ.

PopAllvoid
# PopAll
C#
public void PopAll();

Возвращает текущую область к корню без удаления содержимого. Это сброс позиции построения, не Clear и не надёжный способ закрыть неправильно составленную строку BBCode.

PopContextvoid
# PopContext
C#
public void PopContext();

Выходит из вложенных областей до ближайшей границы PushContext включительно. Без такой границы поднимается к корню. Уже добавленный текст остаётся.

PushBgcolorvoid
# PushBgcolor
C#
public void PushBgcolor(Color bgcolor);

Открывает область фоновой прямоугольной заливки под текстом; это не цвет глифов PushColor. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
bgcolorColor—
bgcolor

Цвет заливки под текстом.

PushBoldvoid
# PushBold
C#
public void PushBold();

Открывает область жирного шрифта темы; при активном курсиве выбирает сочетание жирного и курсива. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

PushBoldItalicsvoid
# PushBoldItalics
C#
public void PushBoldItalics();

Открывает область жирного курсивного шрифта темы. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

PushCellvoid
# PushCell
C#
public void PushCell();

Открывает следующую ячейку только когда текущая область — таблица. Сразу настройте SetCell-методы, затем добавляйте текст и форматирование; Pop возвращает в таблицу. После каждого количества ячеек, равного числу столбцов, начинается следующая строка. Внутри ячейки можно открыть вложенную таблицу.

PushColorvoid
# PushColor
C#
public void PushColor(Color color);

Открывает область цвета глифов текста с учётом альфы. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
colorColor—
color

Цвет соответствующего текста, контура или линии.

PushContextvoid
# PushContext
C#
public void PushContext();

Ставит границу контекста для группы последующих Push-областей. PopContext закрывает вложенные области до этой границы; это не отмена уже добавленного текста.

PushCustomfxvoid
# PushCustomfx
C#
public void PushCustomfx(RichTextEffect effect, Reckfell.Collections.Dictionary env);

Открывает область эффекта: вызовите PushCustomfx, добавьте текст через AddText и закройте Pop. Позволяет использовать ресурс напрямую без регистрации BBCode-тега. env передаётся по общей ссылке; для независимых параметров создайте отдельный словарь. Не создаёт текст и не запускает эффект на уже завершённых областях.

Параметры
ИмяТипПо умолчанию
effectRichTextEffect—
envReckfell.Collections.Dictionary—
effect

Действительный ресурс RichTextEffect.

env

Отдельный словарь параметров области; сохраняется по общей ссылке.

PushDropcapvoid
# PushDropcap
C#
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.

Параметры
ИмяТипПо умолчанию
stringstring—
fontFont—
sizeint—
dropcapMarginsRect2?default
colorColor?default
outlineSizeint0
outlineColorColor?default
string

Непустой текст буквицы.

font

Действительный общий ресурс Font.

size

Положительный размер шрифта буквицы в пикселях.

dropcapMargins

Поля вокруг буквицы как Rect2.

color

Цвет соответствующего текста, контура или линии.

outlineSize

Неотрицательная толщина контура в пикселях.

outlineColor

Цвет контура буквицы.

PushFgcolorvoid
# PushFgcolor
C#
public void PushFgcolor(Color fgcolor);

Открывает область прямоугольной заливки переднего плана поверх текста. Для обычного цвета букв используйте PushColor; непрозрачная заливка может закрыть буквы. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
fgcolorColor—
fgcolor

Цвет заливки поверх текста.

PushFontvoid
# PushFont
C#
public void PushFont(Font font, int fontSize = 0);

Открывает область заданного ресурса Font и необязательного размера. Ресурс общий; не освобождайте его как заимствованный объект метки. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
fontFont—
fontSizeint0
font

Действительный общий ресурс Font.

fontSize

Размер шрифта в пикселях; у PushFont 0 оставляет размер по текущим правилам.

PushFontSizevoid
# PushFontSize
C#
public void PushFontSize(int fontSize);

Открывает область положительного размера шрифта в пикселях, сохраняя выбранный шрифт. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
fontSizeint—
fontSize

Размер шрифта в пикселях; у PushFont 0 оставляет размер по текущим правилам.

PushHintvoid
# PushHint
C#
public void PushHint(string description);

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

Параметры
ИмяТипПо умолчанию
descriptionstring—
description

Текст подсказки следующей области.

PushIndentvoid
# PushIndent
C#
public void PushIndent(int level);

Открывает область отступа с неотрицательным уровнем. Не вставляет пробелы в исходный Text. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
levelint—
level

Неотрицательный уровень отступа/списка.

PushItalicsvoid
# PushItalics
C#
public void PushItalics();

Открывает область курсивного шрифта темы; при активном жирном выбирает жирный курсив. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

PushLanguagevoid
# PushLanguage
C#
public void PushLanguage(string language);

Открывает область языковой подсказки для формирования текста. Не переводит её содержимое. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
languagestring—
language

Языковая подсказка формирования, не целевой язык перевода.

PushList2 перегрузки
# PushList · 1/2
C#
public void PushList(int level, RichTextLabel.ListType type, bool capitalize);

Открывает список заданного типа и уровня. Добавляйте текст пунктов, разделяя их Newline; маркеры и нумерация относятся к отображению, не к исходной BBCode-строке. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
levelint—
typeRichTextLabel.ListType—
capitalizebool—
level

Неотрицательный уровень отступа/списка.

type

Тип маркера или нумерации списка ListType.

capitalize

Использовать верхний регистр в буквенной/римской нумерации.

# PushList · 2/2
C#
public void PushList(int level, RichTextLabel.ListType type, bool capitalize, string bullet = "\u2022");

Открывает список заданного типа и уровня. Добавляйте текст пунктов, разделяя их Newline; маркеры и нумерация относятся к отображению, не к исходной BBCode-строке. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
levelint—
typeRichTextLabel.ListType—
capitalizebool—
bulletstring"\u2022"
level

Неотрицательный уровень отступа/списка.

type

Тип маркера или нумерации списка ListType.

capitalize

Использовать верхний регистр в буквенной/римской нумерации.

bullet

Строка маркера маркированного списка.

PushMeta3 перегрузки
# PushMeta · 1/3
C#
public void PushMeta(Variant data);

Открывает область метаданных для следующего текста; закройте её Pop. data передаётся событиям MetaClicked/MetaHoverStarted/MetaHoverEnded. Это может быть ID или URL, но сам RichTextLabel его не открывает. underlineMode управляет видом ссылки, tooltip — подсказкой.

Параметры
ИмяТипПо умолчанию
dataVariant—
data

Метаданные области как Variant, например ID или URL.

# PushMeta · 2/3
C#
public void PushMeta(Variant data, RichTextLabel.MetaUnderline underlineMode);

Открывает область метаданных для следующего текста; закройте её Pop. data передаётся событиям MetaClicked/MetaHoverStarted/MetaHoverEnded. Это может быть ID или URL, но сам RichTextLabel его не открывает. underlineMode управляет видом ссылки, tooltip — подсказкой.

Параметры
ИмяТипПо умолчанию
dataVariant—
underlineModeRichTextLabel.MetaUnderline—
data

Метаданные области как Variant, например ID или URL.

underlineMode

Условия подчёркивания области метаданных.

# PushMeta · 3/3
C#
public void PushMeta(Variant data, RichTextLabel.MetaUnderline underlineMode = RichTextLabel.MetaUnderline.Always, string tooltip = "");

Открывает область метаданных для следующего текста; закройте её Pop. data передаётся событиям MetaClicked/MetaHoverStarted/MetaHoverEnded. Это может быть ID или URL, но сам RichTextLabel его не открывает. underlineMode управляет видом ссылки, tooltip — подсказкой.

Параметры
ИмяТипПо умолчанию
dataVariant—
underlineModeRichTextLabel.MetaUnderlineRichTextLabel.MetaUnderline.Always
tooltipstring""
data

Метаданные области как Variant, например ID или URL.

underlineMode

Условия подчёркивания области метаданных.

tooltip

Текст подсказки области, пустая строка — без явной подсказки.

PushMonovoid
# PushMono
C#
public void PushMono();

Открывает область моноширинного шрифта темы. Не включает подсветку кода или анализ языка. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

PushNormalvoid
# PushNormal
C#
public void PushNormal();

Открывает область обычного шрифта темы. Не сбрасывает все прочие цвета, отступы и вложенные области. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

PushOutlineColorvoid
# PushOutlineColor
C#
public void PushOutlineColor(Color color);

Открывает область цвета контура глифов. Само по себе не задаёт ненулевую толщину контура. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
colorColor—
color

Цвет соответствующего текста, контура или линии.

PushOutlineSizevoid
# PushOutlineSize
C#
public void PushOutlineSize(int outlineSize);

Открывает область толщины контура в пикселях; 0 отключает контур в этой области. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
outlineSizeint—
outlineSize

Неотрицательная толщина контура в пикселях.

PushParagraph3 перегрузки
# PushParagraph · 1/3
C#
public void PushParagraph(HorizontalAlignment alignment, Control.TextDirection baseDirection, string language, TextServer.StructuredTextParser stParser);

Открывает область параметров абзаца: выравнивание, направление, язык, BiDi-парсер, выравнивание по ширине и tab-позиции. Это параметры содержимого, не контейнер Control. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
alignmentHorizontalAlignment—
baseDirectionControl.TextDirection—
languagestring—
stParserTextServer.StructuredTextParser—
alignment

Горизонтальное выравнивание содержимого абзаца.

baseDirection

Базовое направление BiDi-текста.

language

Языковая подсказка формирования, не целевой язык перевода.

stParser

Режим разбора структурированного двунаправленного текста.

# PushParagraph · 2/3
C#
public void PushParagraph(HorizontalAlignment alignment, Control.TextDirection baseDirection, string language, TextServer.StructuredTextParser stParser, TextServer.JustificationFlag justificationFlags, ReadOnlySpan<float> tabStops);

Открывает область параметров абзаца: выравнивание, направление, язык, BiDi-парсер, выравнивание по ширине и tab-позиции. Это параметры содержимого, не контейнер Control. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
alignmentHorizontalAlignment—
baseDirectionControl.TextDirection—
languagestring—
stParserTextServer.StructuredTextParser—
justificationFlagsTextServer.JustificationFlag—
tabStopsReadOnlySpan<float>—
alignment

Горизонтальное выравнивание содержимого абзаца.

baseDirection

Базовое направление BiDi-текста.

language

Языковая подсказка формирования, не целевой язык перевода.

stParser

Режим разбора структурированного двунаправленного текста.

justificationFlags

Биты правил выравнивания по ширине.

tabStops

Позиции табуляции в пикселях.

# PushParagraph · 3/3
C#
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.

Параметры
ИмяТипПо умолчанию
alignmentHorizontalAlignment—
baseDirectionControl.TextDirectionControl.TextDirection.Auto
languagestring""
stParserTextServer.StructuredTextParserTextServer.StructuredTextParser.Default
justificationFlagsTextServer.JustificationFlagTextServer.JustificationFlag.Kashida | TextServer.JustificationFlag.WordBound | TextServer.JustificationFlag.SkipLastLine | TextServer.JustificationFlag.DoNotSkipSingleLine
tabStopsfloat[]null
alignment

Горизонтальное выравнивание содержимого абзаца.

baseDirection

Базовое направление BiDi-текста.

language

Языковая подсказка формирования, не целевой язык перевода.

stParser

Режим разбора структурированного двунаправленного текста.

justificationFlags

Биты правил выравнивания по ширине.

tabStops

Позиции табуляции в пикселях.

PushStrikethrough2 перегрузки
# PushStrikethrough · 1/2
C#
public void PushStrikethrough();

Открывает перечёркивание текста. Не удаляет символы из GetParsedText или выделения. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

# PushStrikethrough · 2/2
C#
public void PushStrikethrough(Color? color = default);

Открывает перечёркивание текста. Не удаляет символы из GetParsedText или выделения. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
colorColor?default
color

Цвет соответствующего текста, контура или линии.

PushTable2 перегрузки
# PushTable · 1/2
C#
public void PushTable(int columns, InlineAlignment inlineAlign, int alignToRow);

Открывает таблицу с положительным числом столбцов. Затем настройте столбцы, для каждой ячейки вызовите PushCell, добавьте содержимое и закройте ячейку Pop; после всех ячеек ещё один Pop закрывает таблицу. Ячейки заполняются по порядку строк; отдельного PushRow нет. alignToRow выбирает строку для вертикального выравнивания, -1 — последнюю. name задаёт описание для доступности, не видимый заголовок.

Параметры
ИмяТипПо умолчанию
columnsint—
inlineAlignInlineAlignment—
alignToRowint—
columns

Положительное число столбцов таблицы.

inlineAlign

Выравнивание встроенного объекта относительно строки текста.

alignToRow

Индекс строки выравнивания от 0; -1 выбирает последнюю.

# PushTable · 2/2
C#
public void PushTable(int columns, InlineAlignment inlineAlign = InlineAlignment.TopTo, int alignToRow = -1, string name = "");

Открывает таблицу с положительным числом столбцов. Затем настройте столбцы, для каждой ячейки вызовите PushCell, добавьте содержимое и закройте ячейку Pop; после всех ячеек ещё один Pop закрывает таблицу. Ячейки заполняются по порядку строк; отдельного PushRow нет. alignToRow выбирает строку для вертикального выравнивания, -1 — последнюю. name задаёт описание для доступности, не видимый заголовок.

Параметры
ИмяТипПо умолчанию
columnsint—
inlineAlignInlineAlignmentInlineAlignment.TopTo
alignToRowint-1
namestring""
columns

Положительное число столбцов таблицы.

inlineAlign

Выравнивание встроенного объекта относительно строки текста.

alignToRow

Индекс строки выравнивания от 0; -1 выбирает последнюю.

name

Имя для доступности таблицы или столбца, не вставляемый заголовок.

PushUnderline2 перегрузки
# PushUnderline · 1/2
C#
public void PushUnderline();

Открывает подчёркивание текста. Прозрачный цвет с alpha = 0 означает использование текущего цвета текста и альфы темы, а не невидимую линию. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

# PushUnderline · 2/2
C#
public void PushUnderline(Color? color = default);

Открывает подчёркивание текста. Прозрачный цвет с alpha = 0 означает использование текущего цвета текста и альфы темы, а не невидимую линию. Добавьте содержимое и закройте область через Pop. Не переписывает уже добавленные элементы и исходное Text.

Параметры
ИмяТипПо умолчанию
colorColor?default
color

Цвет соответствующего текста, контура или линии.

ReloadEffectsvoid
# ReloadEffects
C#
public void ReloadEffects();

Повторно разбирает сохранённый Text только при включённом BBCode и отсутствии внешнего ручного изменения стека. Для вручную построенных областей не является универсальной перезагрузкой: перестройте нужное содержимое явно.

RemoveParagraph2 перегрузки
# RemoveParagraph · 1/2
C#
public bool RemoveParagraph(int paragraph);

Удаляет абзац основного потока вместе с принадлежащим содержимым и снимает выделение. Индексы последующих абзацев сдвигаются; при удалении единственного остаётся пустое содержимое с одним абзацем. Не переписывает исходный Text и не имеет встроенного Undo. noInvalidate = false пересчитывает затронутые кэши; true оставляет их для оптимизированного пути, который требует отдельно обеспечить актуальность данных. Возвращает false для неверного индекса.

Параметры
ИмяТипПо умолчанию
paragraphint—
paragraph

Индекс абзаца основного потока от 0 до GetParagraphCount() - 1.

Возвращает bool

Удаляет абзац основного потока вместе с принадлежащим содержимым и снимает выделение. Индексы последующих абзацев сдвигаются; при удалении единственного остаётся пустое содержимое с одним абзацем. Не переписывает исходный Text и не имеет встроенного Undo. noInvalidate = false пересчитывает затронутые кэши; true оставляет их для оптимизированного пути, который требует отдельно обеспечить актуальность данных. Возвращает false для неверного индекса.

# RemoveParagraph · 2/2
C#
public bool RemoveParagraph(int paragraph, bool noInvalidate = false);

Удаляет абзац основного потока вместе с принадлежащим содержимым и снимает выделение. Индексы последующих абзацев сдвигаются; при удалении единственного остаётся пустое содержимое с одним абзацем. Не переписывает исходный Text и не имеет встроенного Undo. noInvalidate = false пересчитывает затронутые кэши; true оставляет их для оптимизированного пути, который требует отдельно обеспечить актуальность данных. Возвращает false для неверного индекса.

Параметры
ИмяТипПо умолчанию
paragraphint—
noInvalidateboolfalse
paragraph

Индекс абзаца основного потока от 0 до GetParagraphCount() - 1.

noInvalidate

Оставить кэши для оптимизированного пути; обычно используйте false.

Возвращает bool

Удаляет абзац основного потока вместе с принадлежащим содержимым и снимает выделение. Индексы последующих абзацев сдвигаются; при удалении единственного остаётся пустое содержимое с одним абзацем. Не переписывает исходный Text и не имеет встроенного Undo. noInvalidate = false пересчитывает затронутые кэши; true оставляет их для оптимизированного пути, который требует отдельно обеспечить актуальность данных. Возвращает false для неверного индекса.

ScrollToLinevoid
# ScrollToLine
C#
public void ScrollToLine(int line);

Прокручивает к визуальной строке переноса, не к логической строке исходного BBCode. Значения <= 0 ведут к началу, слишком большой индекс — к концу доступного расчёта. Сначала дождитесь готовности, если нужна точная позиция.

Параметры
ИмяТипПо умолчанию
lineint—
line

Индекс визуальной строки переноса от 0.

ScrollToParagraphvoid
# ScrollToParagraph
C#
public void ScrollToParagraph(int paragraph);

Прокручивает к абзацу основного содержимого. Значения <= 0 ведут к началу, за пределами рассчитанных абзацев — к концу полосы. Не выделяет текст и не меняет его.

Параметры
ИмяТипПо умолчанию
paragraphint—
paragraph

Индекс абзаца основного потока от 0.

ScrollToSelectionvoid
# ScrollToSelection
C#
public void ScrollToSelection();

Прокручивает к началу текущего выделения по GetSelectionLineOffset. При отсутствии выделения ничего не делает. Не создаёт выделение и не изменяет содержимое.

SelectAllvoid
# SelectAll
C#
public void SelectAll();

Выделяет построенное содержимое при SelectionEnabled. Не выполняет копирование в буфер. При фоновом расчёте сначала дождитесь IsFinished, чтобы границы охватывали готовое содержимое.

SetAutowrapModevoid
# SetAutowrapMode
C#
public void SetAutowrapMode(TextServer.AutowrapMode autowrapMode);

Правило переноса по доступной ширине: отключение, произвольный перенос или перенос по словам. Меняет визуальные строки и размеры, сохраняя исходный Text. Для предсказуемого результата задайте метке ширину через компоновку.

Параметры
ИмяТипПо умолчанию
autowrapModeTextServer.AutowrapMode—
autowrapMode

Режим переноса по доступной ширине.

SetAutowrapTrimFlagsvoid
# SetAutowrapTrimFlags
C#
public void SetAutowrapTrimFlags(TextServer.LineBreakFlag autowrapTrimFlags);

Флаги обработки краевых пробелов и отступа при переносе. Setter сохраняет только биты trim-маски TextServer; другие LineBreakFlag не включают здесь собственный режим переноса. Исходный текст не обрезается.

Параметры
ИмяТипПо умолчанию
autowrapTrimFlagsTextServer.LineBreakFlag—
autowrapTrimFlags

Биты обработки краевых пробелов/отступа; сохраняется только trim-маска.

SetCellBorderColorvoid
# SetCellBorderColor
C#
public void SetCellBorderColor(Color color);

Задаёт цвет границы только текущей ячейки. Color(0,0,0,0) служит возвратом к цвету темы, поэтому не гарантирует скрытую границу при ненулевой теме. Настраивайте непосредственно в ячейке до открытия вложенных Push-областей.

Параметры
ИмяТипПо умолчанию
colorColor—
color

Модуляция изображения или цвет соответствующего оформления.

SetCellPaddingvoid
# SetCellPadding
C#
public void SetCellPadding(Rect2 padding);

Задаёт внутренние поля текущей ячейки: Rect2.Position.X/Y — слева/сверху, Rect2.Size.X/Y — справа/снизу. Это упаковка четырёх полей, не обычный прямоугольник с шириной и высотой. Используйте неотрицательные значения и настраивайте сразу после PushCell.

Параметры
ИмяТипПо умолчанию
paddingRect2—
padding

Rect2(left, top, right, bottom) в пикселях полей.

SetCellRowBackgroundColorvoid
# SetCellRowBackgroundColor
C#
public void SetCellRowBackgroundColor(Color oddRowBg, Color evenRowBg);

Задаёт два цвета фона текущей ячейки; при отрисовке выбирается цвет по чётности строки таблицы. Не перекрашивает автоматически остальные ячейки этой строки. Color(0,0,0,0) возвращает соответствующий фон темы.

Параметры
ИмяТипПо умолчанию
oddRowBgColor—
evenRowBgColor—
oddRowBg

Фон этой ячейки для нечётной строки; нулевой Color возвращает тему.

evenRowBg

Фон этой ячейки для чётной строки; нулевой Color возвращает тему.

SetCellSizeOverridevoid
# SetCellSizeOverride
C#
public void SetCellSizeOverride(Vector2 minSize, Vector2 maxSize);

Сохраняет ограничения размеров текущей ячейки. В текущей реализации раскладки используются положительные Y как минимум/максимум высоты; X не задаёт ширину столбца. Неположительный Y означает отсутствие соответствующего ограничения. В многоабзацной ячейке Y ограничивает расчётную высоту отдельных абзацев, не их общую сумму. Для ширины настройте столбцы; min/max должны быть согласованы. Вызывайте сразу после PushCell.

Параметры
ИмяТипПо умолчанию
minSizeVector2—
maxSizeVector2—
minSize

В текущей раскладке положительный Y ограничивает высоту снизу; X не задаёт ширину.

maxSize

В текущей раскладке положительный Y ограничивает высоту сверху; <= 0 снимает ограничение.

SetContextMenuEnabledvoid
# SetContextMenuEnabled
C#
public void SetContextMenuEnabled(bool enabled);

Разрешает открытие встроенного пользовательского меню. false не удаляет PopupMenu и не запрещает программные GetMenu/MenuOption. Это настройка интерфейса, а не запрет копирования данных приложением.

Параметры
ИмяТипПо умолчанию
enabledbool—
enabled

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

SetDeselectOnFocusLossEnabledvoid
# SetDeselectOnFocusLossEnabled
C#
public void SetDeselectOnFocusLossEnabled(bool enable);

Разрешает снятие выделения при потере фокуса. При переключении false → true у метки без фокуса существующее выделение снимается сразу. Для сохранения выделения при переходе к другому элементу используйте false.

Параметры
ИмяТипПо умолчанию
enablebool—
enable

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

SetDragAndDropSelectionEnabledvoid
# SetDragAndDropSelectionEnabled
C#
public void SetDragAndDropSelectionEnabled(bool enable);

Разрешает пользовательское перетаскивание выделенного обычного текста из метки. Нужно SelectionEnabled; не включает редактирование или приём произвольных файлов. Назначение свойства не запускает перенос.

Параметры
ИмяТипПо умолчанию
enablebool—
enable

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

SetEffectsvoid
# SetEffects
C#
public void SetEffects(Reckfell.Collections.Array effects);

Ресурсы пользовательских BBCode-эффектов. Setter заменяет массив и вызывает ReloadEffects; getter разделяет массив, поэтому изменение результата само по себе не перезапускает разбор. Эффекты с совпадающими именами неоднозначны: используется первое подходящее имя. Для прямого программного применения используйте PushCustomfx.

Параметры
ИмяТипПо умолчанию
effectsReckfell.Collections.Array—
effects

Массив ресурсов RichTextEffect для зарегистрированных тегов.

SetFitContentvoid
# SetFitContent
C#
public void SetFitContent(bool enabled);

Учитывает содержимое в минимальном размере метки. Родительский контейнер может расширить элемент; это не команда установить точный Size и не уменьшение шрифта. Учитывайте взаимодействие с переносами и ограничениями родителя.

Параметры
ИмяТипПо умолчанию
enabledbool—
enabled

Включить описанную настройку компоновки.

SetHintUnderlinevoid
# SetHintUnderline
C#
public void SetHintUnderline(bool enable);

Разрешает визуальное подчёркивание областей PushHint. Не включает или отключает само содержимое подсказки и не меняет текст.

Параметры
ИмяТипПо умолчанию
enablebool—
enable

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

SetHorizontalAlignmentvoid
# SetHorizontalAlignment
C#
public void SetHorizontalAlignment(HorizontalAlignment alignment);

Выравнивание основного текста по горизонтали; локальная разметка абзаца может задавать своё. Fill использует JustificationFlags для выравнивания по ширине. Не перемещает сам Control в родительском контейнере.

Параметры
ИмяТипПо умолчанию
alignmentHorizontalAlignment—
alignment

Выравнивание текста внутри метки.

SetJustificationFlagsvoid
# SetJustificationFlags
C#
public void SetJustificationFlags(TextServer.JustificationFlag justificationFlags);

Правила растяжения строк при выравнивании по ширине, например обработка слов и последней строки. Действуют вместе с соответствующим выравниванием; не задают ширину метки.

Параметры
ИмяТипПо умолчанию
justificationFlagsTextServer.JustificationFlag—
justificationFlags

Биты правил выравнивания текста по ширине.

SetLanguagevoid
# SetLanguage
C#
public void SetLanguage(string language);

Языковая подсказка текстовой системе для формирования и переноса. Не переводит строку на другой язык; перевод UI исходного Text — отдельный механизм.

Параметры
ИмяТипПо умолчанию
languagestring—
language

Код языковой подсказки для формирования текста.

SetMaximumFontSizevoid
# SetMaximumFontSize
C#
public void SetMaximumFontSize(int size);

Верхняя граница подбора при ResizeFontToFit. Согласуйте с MinimumFontSize; это ограничение подбора, а не общий запрет локальных размеров BBCode.

Параметры
ИмяТипПо умолчанию
sizeint—
size

Положительная граница подбора шрифта, согласованная со второй границей.

SetMetaUnderlinevoid
# SetMetaUnderline
C#
public void SetMetaUnderline(bool enable);

Разрешает подчёркивание областей метаданных с учётом их MetaUnderline. Не создаёт ссылку и не открывает URL. Явная область PushUnderline остаётся отдельным форматированием.

Параметры
ИмяТипПо умолчанию
enablebool—
enable

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

SetMinimumFontSizevoid
# SetMinimumFontSize
C#
public void SetMinimumFontSize(int size);

Нижняя граница подбора при ResizeFontToFit. Задавайте положительное значение не больше MaximumFontSize. Само назначение не означает, что именно этот размер уже нарисован.

Параметры
ИмяТипПо умолчанию
sizeint—
size

Положительная граница подбора шрифта, согласованная со второй границей.

SetProgressBarDelayvoid
# SetProgressBarDelay
C#
public void SetProgressBarDelay(int delayMs);

Задержка показа индикатора фоновой загрузки в миллисекундах. Положительное значение ждёт этот интервал; 0 и отрицательные значения отключают индикатор. Не задаёт скорость разбора или задержку появления символов.

Параметры
ИмяТипПо умолчанию
delayMsint—
delayMs

Положительная задержка в миллисекундах; <= 0 отключает индикатор.

SetResizeFontToFitvoid
# SetResizeFontToFit
C#
public void SetResizeFontToFit(bool enabled);

Разрешает подбирать размер основного шрифта для доступной области в диапазоне MinimumFontSize–MaximumFontSize. Не заменяет FitContent: здесь меняется шрифт, а не требование минимального размера. Подбор зависит от ширины и высоты; слишком маленький минимум не гарантирует читаемость.

Параметры
ИмяТипПо умолчанию
enabledbool—
enabled

Включить описанную настройку компоновки.

SetScrollActivevoid
# SetScrollActive
C#
public void SetScrollActive(bool active);

Разрешает встроенную вертикальную прокрутку. Переключение вызывает повторное применение исходного Text: при смешении с ручным AddText/Push содержимое может быть перестроено из сохранённой строки. Задавайте режим до ручного построения. Не означает, что всё содержимое помещается без полосы.

Параметры
ИмяТипПо умолчанию
activebool—
active

Разрешить встроенную вертикальную прокрутку.

SetScrollFollowvoid
# SetScrollFollow
C#
public void SetScrollFollow(bool follow);

Разрешает следование за концом дополняемого текста. Если пользователь прокрутил вверх, фактическое следование может приостановиться до возвращения к низу. Getter сообщает настройку, а не факт положения внизу.

Параметры
ИмяТипПо умолчанию
followbool—
follow

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

SetScrollFollowVisibleCharactersvoid
# SetScrollFollowVisibleCharacters
C#
public void SetScrollFollowVisibleCharacters(bool follow);

Прокручивает к области, раскрываемой через VisibleCharacters. Отличается от следования за полным концом текста: предназначено для постепенного показа. Назначение true может сразу изменить прокрутку.

Параметры
ИмяТипПо умолчанию
followbool—
follow

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

SetSelectionEnabledvoid
# SetSelectionEnabled
C#
public void SetSelectionEnabled(bool enabled);

Разрешает выделение отображаемого текста и SelectAll. Включение задаёт FocusMode.All; отключение снимает активное выделение и устанавливает режим фокуса доступности. Не делает метку редактируемой и не изменяет Text.

Параметры
ИмяТипПо умолчанию
enabledbool—
enabled

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

SetShortcutKeysEnabledvoid
# SetShortcutKeysEnabled
C#
public void SetShortcutKeysEnabled(bool enabled);

Разрешает встроенные сочетания команд метки. Не включает SelectionEnabled автоматически и не запрещает прямые программные вызовы SelectAll/MenuOption.

Параметры
ИмяТипПо умолчанию
enabledbool—
enabled

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

SetStructuredTextBidiOverridevoid
# SetStructuredTextBidiOverride
C#
public void SetStructuredTextBidiOverride(TextServer.StructuredTextParser parser);

Выбирает разбор структурированного двунаправленного текста, например адресов и путей. Это настройка формирования, не regex-замена исходной строки. Параметры задаёт StructuredTextBidiOverrideOptions.

Параметры
ИмяТипПо умолчанию
parserTextServer.StructuredTextParser—
parser

Режим разбора структурированного BiDi-текста.

SetStructuredTextBidiOverrideOptionsvoid
# SetStructuredTextBidiOverrideOptions
C#
public void SetStructuredTextBidiOverrideOptions(Reckfell.Collections.Array args);

Параметры структурированного BiDi-разбора. Массив сохраняется по общей ссылке; изменение его содержимого не запускает перерасчёт автоматически. Для обновления назначьте новый массив с отличающимся содержимым: равное содержимое setter может пропустить.

Параметры
ИмяТипПо умолчанию
argsReckfell.Collections.Array—
args

Параметры парсера; массив сохраняется по общей ссылке.

SetTabSizevoid
# SetTabSize
C#
public void SetTabSize(int spaces);

Ширина стандартного шага табуляции в пробелах; используйте положительное значение. Меняет отображение tab, не заменяет его пробелами в Text. Для явных позиций используйте TabStops.

Параметры
ИмяТипПо умолчанию
spacesint—
spaces

Положительный размер шага tab в пробелах.

SetTabStops2 перегрузки
# SetTabStops · 1/2
C#
public void SetTabStops(ReadOnlySpan<float> tabStops);

Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.

Параметры
ИмяТипПо умолчанию
tabStopsReadOnlySpan<float>—
tabStops

Возрастающие положительные позиции tab в пикселях.

# SetTabStops · 2/2
C#
public void SetTabStops(float[] tabStops);

Явные позиции табуляции в пикселях текстовой области; передавайте возрастающие положительные значения. C# float[] передаётся как данные, getter возвращает массив значений: изменение результата не перенастраивает метку. Не задаёт отступы строк исходного текста.

Параметры
ИмяТипПо умолчанию
tabStopsfloat[]—
tabStops

Возрастающие положительные позиции tab в пикселях.

SetTableColumnExpand2 перегрузки
# SetTableColumnExpand · 1/2
C#
public void SetTableColumnExpand(int column, bool expand, int ratio);

Настраивает текущую открытую таблицу; вызывайте до PushCell либо после Pop ячейки. column — индекс от 0, ratio — положительный относительный вес, не пиксели или проценты. expand разрешает распределение места; shrink = true ограничивает растяжение естественным максимумом содержимого, false допускает больше свободной ширины. Это не гарантия фиксированных долей всей таблицы: учитываются минимумы и максимумы. Короткая перегрузка использует shrink = true.

Параметры
ИмяТипПо умолчанию
columnint—
expandbool—
ratioint—
column

Индекс существующего столбца от 0.

expand

Участвовать в распределении ширины таблицы.

ratio

Положительный относительный вес растяжения.

# SetTableColumnExpand · 2/2
C#
public void SetTableColumnExpand(int column, bool expand, int ratio = 1, bool shrink = true);

Настраивает текущую открытую таблицу; вызывайте до PushCell либо после Pop ячейки. column — индекс от 0, ratio — положительный относительный вес, не пиксели или проценты. expand разрешает распределение места; shrink = true ограничивает растяжение естественным максимумом содержимого, false допускает больше свободной ширины. Это не гарантия фиксированных долей всей таблицы: учитываются минимумы и максимумы. Короткая перегрузка использует shrink = true.

Параметры
ИмяТипПо умолчанию
columnint—
expandbool—
ratioint1
shrinkbooltrue
column

Индекс существующего столбца от 0.

expand

Участвовать в распределении ширины таблицы.

ratio

Положительный относительный вес растяжения.

shrink

Ограничивать растяжение естественным максимумом содержимого.

SetTableColumnNamevoid
# SetTableColumnName
C#
public void SetTableColumnName(int column, string name);

Задаёт имя столбца текущей таблицы для доступности. Не вставляет видимую строку заголовка: создайте её ячейки отдельно. Требует текущую область таблицы, не ячейки или шрифта.

Параметры
ИмяТипПо умолчанию
columnint—
namestring—
column

Индекс существующего столбца от 0.

name

Имя для доступности таблицы или столбца, не вставляемый заголовок.

SetTextvoid
# SetText
C#
public void SetText(string text);

Исходная строка для полного построения метки, с переводом UI и разбором BBCode при включённом BbcodeEnabled. Назначение заменяет ручное содержимое; одинаковая непустая строка может ничего не перестроить. AddText, AppendText и Push-методы не дописывают сюда свой результат. Для получившегося обычного текста используйте GetParsedText.

Параметры
ИмяТипПо умолчанию
textstring—
text

Исходный или буквальный текст в зависимости от метода; AddText не разбирает теги.

SetTextDirectionvoid
# SetTextDirection
C#
public void SetTextDirection(Control.TextDirection direction);

Направление текста для BiDi-формирования. Не переставляет символы исходной строки вручную и не переводит текст. Разметка структурированного текста настраивается отдельно.

Параметры
ИмяТипПо умолчанию
directionControl.TextDirection—
direction

Направление формирования текста, не команда изменения строки.

SetThreadedvoid
# SetThreaded
C#
public void SetThreaded(bool threaded);

Разрешает фоновый расчёт раскладки текста; по умолчанию false. Не делает произвольные вызовы RichTextLabel потокобезопасными и не переносит всю отрисовку в другой поток. Следите за IsFinished; до завершения метрики могут описывать только обработанную часть.

Параметры
ИмяТипПо умолчанию
threadedbool—
threaded

Разрешить фоновый расчёт раскладки.

SetUseBbcodevoid
# SetUseBbcode
C#
public void SetUseBbcode(bool enable);

Определяет разбор свойства Text как BBCode. Для ручного AddText разбор не включается; AppendText самостоятельно разбирает разметку. Переключение настройки не гарантирует перестройку вручную изменённого стека.

Параметры
ИмяТипПо умолчанию
enablebool—
enable

Включить разбор Text как BBCode.

SetVerticalAlignmentvoid
# SetVerticalAlignment
C#
public void SetVerticalAlignment(VerticalAlignment alignment);

Размещение текстового содержимого по вертикали внутри области метки. Не меняет вертикальное выравнивание Control у родителя и не включает автоматическую прокрутку.

Параметры
ИмяТипПо умолчанию
alignmentVerticalAlignment—
alignment

Выравнивание текста внутри метки.

SetVisibleCharactersvoid
# SetVisibleCharacters
C#
public void SetVisibleCharacters(int amount);

Лимит постепенного показа: -1 показывает всё, 0 скрывает текст, неотрицательное значение задаёт предел. Поведение до/после формирования глифов выбирает VisibleCharactersBehavior. Это не количество кадров и не UTF-16 Length строки Text. Setter пересчитывает VisibleRatio, но не ограничивает явно слишком большое значение; для анимации держите диапазон от 0 до GetTotalCharacterCount.

Параметры
ИмяТипПо умолчанию
amountint—
amount

Лимит показа; -1 — всё, 0 — ничего.

SetVisibleCharactersBehaviorvoid
# SetVisibleCharactersBehavior
C#
public void SetVisibleCharactersBehavior(TextServer.VisibleCharactersBehavior behavior);

Определяет, применяется ли лимит до формирования текста или к уже сформированным символам/глифам. До формирования может меняться раскладка; после формирования сохраняется контекст полной строки, но единицы показа зависят от режима. Учитывайте лигатуры, составные символы и RTL; не предполагайте один char C# на один видимый глиф.

Параметры
ИмяТипПо умолчанию
behaviorTextServer.VisibleCharactersBehavior—
behavior

Режим VisibleCharactersBehavior текстовой системы.

SetVisibleRatiovoid
# SetVisibleRatio
C#
public void SetVisibleRatio(float ratio);

Доля показа: значения от 0 до 1 переводятся в целый VisibleCharacters с усечением. Значение от 1 показывает всё, отрицательное скрывает. Не создаёт таймер: увеличивайте долю из анимации приложения. Доля относится к счётчику содержимого, не обязательно к числу визуально отдельных букв.

Параметры
ИмяТипПо умолчанию
ratiofloat—
ratio

Доля от 0 до 1; значения от 1 показывают всё.

UpdateImage3 перегрузки
# UpdateImage · 1/3
C#
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.

Параметры
ИмяТипПо умолчанию
keyVariant—
maskRichTextLabel.ImageUpdateMask—
imageTexture2D—
widthint—
heightint—
colorColor?—
inlineAlignInlineAlignment—
regionRect2?—
padbool—
tooltipstring—
sizeInPercentbool—
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 выбирает проценты для обеих осей.

# UpdateImage · 2/3
C#
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.

Параметры
ИмяТипПо умолчанию
keyVariant—
maskRichTextLabel.ImageUpdateMask—
imageTexture2D—
widthint—
heightint—
colorColor?—
inlineAlignInlineAlignment—
regionRect2?—
padbool—
tooltipstring—
widthInPercentbool—
heightInPercentbool—
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

Выбирать проценты вместо пикселей по высоте; база процентов — ширина текста.

# UpdateImage · 3/3
C#
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.

Параметры
ИмяТипПо умолчанию
keyVariant—
maskRichTextLabel.ImageUpdateMask—
imageTexture2D—
widthfloat0f
heightfloat0f
colorColor?default
inlineAlignInlineAlignmentInlineAlignment.Center
regionRect2?default
padboolfalse
tooltipstring""
widthUnitRichTextLabel.ImageUnitRichTextLabel.ImageUnit.Pixel
heightUnitRichTextLabel.ImageUnitRichTextLabel.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

Текст подсказки изображения.

widthUnit

Pixel, Percent или Em для ширины; в UpdateImage применяется через маску WidthUnit.

heightUnit

Единицы высоты; Percent использует ширину области, Em умножает размер шрифта.

Сигналы и события4

FinishedСобытие
# Finished
C#
public event Action Finished;

Сигнал завершения очередного расчёта текста. Не означает, что уже нарисован кадр, закончилась анимация или новые изменения больше не потребуют расчёта. При Threaded испускается из пути рабочего потока; изменения других элементов UI переносите в основной поток через отложенный вызов.

MetaClickedСобытие
# MetaClicked
C#
public event RichTextLabel.MetaClickedEventHandler MetaClicked;

Передаёт metadata активированной области ссылки. Приложение решает, открыть URL, показать справку или выполнить своё действие. metadata — Variant, не обязательно string; сначала проверьте ожидаемый тип.

Параметры обработчика
ИмяТипПо умолчанию
metaVariant—
meta

Метаданные соответствующей области; проверьте ожидаемый тип Variant.

MetaHoverEndedСобытие
# MetaHoverEnded
C#
public event RichTextLabel.MetaHoverEndedEventHandler MetaHoverEnded;

Передаёт метаданные области, наведение на которую завершилось. Используйте для снятия собственного состояния подсказки/подсветки.

Параметры обработчика
ИмяТипПо умолчанию
metaVariant—
meta

Метаданные соответствующей области; проверьте ожидаемый тип Variant.

MetaHoverStartedСобытие
# MetaHoverStarted
C#
public event RichTextLabel.MetaHoverStartedEventHandler MetaHoverStarted;

Передаёт метаданные области при начале наведения. Не означает переход по ссылке или изменение выбранного текста.

Параметры обработчика
ИмяТипПо умолчанию
metaVariant—
meta

Метаданные соответствующей области; проверьте ожидаемый тип Variant.

RichTextLabel.ImageUnit

ЗначениеОписание
Em = 2

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

Percent = 1

Изображения, нарисованные с использованием этой единицы, будут составлять процент от ширины элемента управления.

Pixel = 0

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

RichTextLabel.ImageUpdateMask

ЗначениеОписание
Alignment = 8

Если этот бит установлен, RichTextLabel.UpdateImage изменяет выравнивание изображения по строке.

Color = 4

Если этот бит установлен, RichTextLabel.UpdateImage изменяет цвет изображения.

Pad = 32

Если этот бит установлен, RichTextLabel.UpdateImage изменяет заполнение изображения.

Region = 16

Если этот бит установлен, RichTextLabel.UpdateImage изменяет область текстуры изображения.

Size = 2

Если этот бит установлен, RichTextLabel.UpdateImage изменяет размер изображения.

Texture = 1

Если этот бит установлен, RichTextLabel.UpdateImage изменяет текстуру изображения.

Tooltip = 64

Если этот бит установлен, RichTextLabel.UpdateImage изменяет всплывающую подсказку изображения.

WidthUnit = 128

Если этот бит установлен, метод RichTextLabel.UpdateImage изменяет единицы измерения, используемые для расчета размера изображения.

RichTextLabel.ListType

ЗначениеОписание
Dots = 3

Каждый элемент списка имеет маркер в виде заполненного круга.

Letters = 1

Каждый элемент списка имеет буквенный маркер.

Numbers = 0

Каждый элемент списка имеет числовой маркер.

СПИСОК ИСТОЧНИКОВ

Roman = 2

Каждый пункт списка имеет римский номер-маркер.

RichTextLabel.MenuItems

ЗначениеОписание
Copy = 0

Копирует выделенный текст.

Max = 2

Представляет размер перечисления RichTextLabel.MenuItems.

SelectAll = 1

Выделяет весь текст RichTextLabel.

RichTextLabel.MetaUnderline

ЗначениеОписание
Always = 1

Если RichTextLabel.MetaUnderlined имеет значение true, метатег всегда отображает подчеркивание.

Never = 0

Метатег не отображает подчеркивание, даже если RichTextLabel.MetaUnderlined имеет значение true.

OnHover = 2

Если RichTextLabel.MetaUnderlined имеет значение true, метатег отображает подчеркивание при наведении на него курсора мыши.

Свойства темы

Это ключи ресурсов Theme, а не свойства C# класса. Используйте методы GetTheme…() и AddTheme…Override() у Control с соответствующим типом значения.

Ключ и типОписание
default_color
Color

Цвет текста по умолчанию.

По умолчанию: Color(1, 1, 1, 1)
font_outline_color
Color

Оттенок контура текста по умолчанию.

По умолчанию: Color(0, 0, 0, 1)
font_selected_color
Color

Цвет выделенного текста, используемый, когда RichTextLabel.SelectionEnabled равен true. Если равен Color(0, 0, 0, 0), он будет проигнорирован.

По умолчанию: Color(0, 0, 0, 0)
font_shadow_color
Color

Цвет тени шрифта.

По умолчанию: Color(0, 0, 0, 0)
selection_color
Color

Цвет поля выбора.

По умолчанию: Color(0.1, 0.1, 1, 0.8)
table_border
Color

Цвет границы ячейки по умолчанию.

По умолчанию: Color(0, 0, 0, 0)
table_even_row_bg
Color

Цвет фона по умолчанию для четных строк.

По умолчанию: Color(0, 0, 0, 0)
table_odd_row_bg
Color

Цвет фона по умолчанию для нечетных строк.

По умолчанию: Color(0, 0, 0, 0)
line_separation
int

Дополнительный вертикальный интервал между строками (в пикселях), интервал добавляется к спуску строки. Это значение может быть отрицательным.

По умолчанию: 0
outline_size
int

Размер контура текста. Примечание: При использовании шрифта с включенным FontFile.MultichannelSignedDistanceField его FontFile.MsdfPixelRange должен быть установлен как минимум в дважды значения RichTextLabel.outline_size, чтобы контур выглядел правильно. В противном случае контур может оказаться обрезанным раньше, чем предполагалось.

По умолчанию: 0
paragraph_separation
int

Дополнительный вертикальный интервал между абзацами (в пикселях). Интервал добавляется после последней строки. Это значение может быть отрицательным.

По умолчанию: 0
shadow_offset_x
int

Горизонтальное смещение тени шрифта.

По умолчанию: 1
shadow_offset_y
int

Вертикальное смещение тени шрифта.

По умолчанию: 1
shadow_outline_size
int

Размер контура тени.

По умолчанию: 1
strikethrough_alpha
int

Прозрачность цвета зачеркивания по умолчанию (в процентах). Для зачеркивания с пользовательским цветом этот элемент темы используется только в том случае, если альфа пользовательского цвета равна 0.0 (полностью прозрачный).

По умолчанию: 50
table_h_separation
int

Горизонтальное разделение элементов в таблице.

По умолчанию: 3
table_v_separation
int

Вертикальное разделение элементов в таблице.

По умолчанию: 3
text_highlight_h_padding
int

Горизонтальный отступ вокруг полей, нарисованных тегами [fgcolor] и [bgcolor]. Это не влияет на внешний вид выделения текста. Чтобы избежать риска перекрытия соседних выделений, установите это значение на 0, чтобы отключить отступ.

По умолчанию: 3
text_highlight_v_padding
int

Вертикальный отступ вокруг полей, нарисованных тегами [fgcolor] и [bgcolor]. Это не влияет на внешний вид выделения текста. Чтобы избежать риска перекрытия соседних выделений, установите это значение на 0, чтобы отключить отступ.

По умолчанию: 3
underline_alpha
int

Прозрачность цвета подчеркивания по умолчанию (в процентах). Для подчеркиваний с пользовательским цветом этот элемент темы используется только в том случае, если альфа пользовательского цвета равна 0.0 (полностью прозрачный).

По умолчанию: 50
bold_font
Font

Шрифт, используемый для жирного текста.

bold_italics_font
Font

Шрифт, используемый для жирного курсивного текста.

italics_font
Font

Шрифт, используемый для курсивного текста.

mono_font
Font

Шрифт, используемый для моноширинного текста.

normal_font
Font

Шрифт текста по умолчанию.

bold_font_size
int

Размер шрифта, используемый для жирного текста.

bold_italics_font_size
int

Размер шрифта, используемый для жирного курсивного текста.

italics_font_size
int

Размер шрифта, используемый для курсивного текста.

mono_font_size
int

Размер шрифта, используемый для моноширинного текста.

normal_font_size
int

Размер шрифта текста по умолчанию.

horizontal_rule
Texture2D

Текстура горизонтальной линейки.

Сосредоточься

focus
StyleBox

Фон, используемый при фокусировке RichTextLabel. Фокус RichTextLabel.focus StyleBox отображается над базовым StyleBox, поэтому следует использовать частично прозрачный StyleBox, чтобы базовый StyleBox оставался видимым. Для этой цели хорошо подходит StyleBox, представляющий контур или подчеркивание. Чтобы отключить визуальный эффект фокуса, назначьте ресурс StyleBoxEmpty. Обратите внимание, что отключение визуального эффекта фокуса навредит удобству использования навигации с помощью клавиатуры/контроллера, поэтому это не рекомендуется по соображениям доступности.

normal
StyleBox

Обычный фон для RichTextLabel.

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.