reckfellENGINE

Label

Обычный текст с переносом, сокращением и управляемым появлением.

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

Label отображает обычный текст; для BBCode-разметки и встроенных эффектов используйте RichTextLabel. По умолчанию выравнивание Left/Top, перенос Off, VisibleCharacters = -1 и MouseFilter = Ignore. Text хранит исходную строку; отображение может переводиться и преобразовываться в верхний регистр, но GetText возвращает исходник.

Для многострочного текста задайте AutowrapMode и ограничьте ширину раскладкой; предусмотрите положительную CustomMinimumSize.X или ограничение максимальной ширины. WordSmart переносит по словам и разбивает слишком длинные фрагменты. Не фиксируйте высоту без учёта длинных переводов. ClipText разрешает обрезание по области, TextOverrunBehavior задаёт сокращение и многоточие — это разные настройки.

ParagraphSeparator задаёт разделитель абзацев с обработкой escape-последовательностей; по умолчанию строка \n означает перевод строки. GetLineCount считает строки после переноса, а не число разделителей; вне дерева возвращает служебное 1. MaxLinesVisible ограничивает окно строк, LinesSkipped пропускает первые строки, не удаляя Text. Для актуальных измерений сначала вызовите GetLineCount или GetMinimumSize, затем GetVisibleLineCount/GetLineHeight/GetRenderedFontSize: часть getters читает уже подготовленные данные. GetVisibleLineCount описывает помещающиеся строки, не подсчитывает реально нарисованные буквы.

Для постепенного появления сначала задайте Text, затем VisibleCharacters или VisibleRatio. GetTotalCharacterCount считает кодовые точки переведённой строки, включая переводы строк; это не C# string.Length, не число графем и не число глифов. Например, A😀é содержит 4 кодовые точки, 5 UTF-16 единиц и 3 пользовательских текстовых элемента. Не режьте C#-строку по этому индексу.

CharsBeforeShaping — режим по умолчанию: сначала обрезает входной текст, поэтому могут меняться перенос и соединение букв. CharsAfterShaping сохраняет полную подготовленную раскладку и ограничивает отображение по символьным позициям. GlyphsAuto/Ltr/Rtl раскрывают глифы по направлению; они не гарантируют по одному целому emoji или составному знаку. Для текста со сложными письменностями выбирайте режим и проверяйте соответствующий шрифт.

Используйте VisibleCharacters = -1 для всего текста либо число от 0 до GetTotalCharacterCount. Избыточное число не ограничивается и может дать VisibleRatio > 1. Повторное присваивание того же Ratio не нормализует такое состояние; явно задайте 1 для показа всего. Доля между 0 и 1 округляет число позиций вниз, но сама доля сохраняется. При замене Text частичная доля сохраняется и пересчитывает число позиций — для новой реплики задайте начало появления заново.

LabelSettings — общий ресурс оформления с приоритетом над соответствующими theme-настройками; шрифт при отсутствии в ресурсе может браться из темы. Изменение общего ресурса затронет все использующие его Label. ResizeFontToFit подбирает размер в области Control между MinimumFontSize и MaximumFontSize. Задавайте 1 ≤ minimum ≤ maximum; setters сами не обеспечивают это условие. Даже минимальный размер может не вместить текст: режим подбора не гарантирует отсутствие обрезания. GetRenderedFontSize сообщает последний рассчитанный размер, а не меняет ресурс шрифта.

GetCharacterBounds возвращает локальный прямоугольник продвижения кластера, не точную рамку окрашенных пикселей. Несколько позиций лигатуры могут иметь одну рамку; отсутствующая/пропущенная позиция возвращает пустой Rect2. Для UI с переводом и Uppercase учитывайте, что индексы относятся к обрабатываемому тексту.

LabelSettings.

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

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

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

Создаёт обычную надпись: Text пустой, Left/Top, AutowrapMode = Off, VisibleCharacters = -1, MouseFilter = Ignore, вертикальный SizeFlags ShrinkCenter.

Свойства25

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

Перенос, Off по умолчанию. WordSmart переносит слова и разбивает длинные фрагменты, Arbitrary использует границы графем. Нужна ограниченная ширина; добавьте положительный минимум или максимум ширины для устойчивой раскладки.

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

Удаление краевых пробелов строк, по умолчанию TrimStartEdgeSpaces | TrimEndEdgeSpaces. Остальные биты LineBreakFlag отбрасываются; они не задают режим переноса.

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

Обрезание по области, false по умолчанию. Снимает естественную ширину текста из минимума; не включает многоточие автоматически и не отменяет CustomMinimumSize/поля стиля.

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

Символ сокращения, … по умолчанию. Используйте один Unicode-символ; более длинная строка предупреждает и сокращается до первого. Не включает TextOverrunBehavior автоматически.

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

Left/Center/Right/Fill для текста внутри области, Left по умолчанию. Left/Right учитывают RTL LayoutDirection; Fill использует JustificationFlags. Не перемещает сам Control.

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

Флаги растяжения текста для HorizontalAlignment = Fill, включая границы слов, кашиду и правила последней строки. Не включают Fill сами по себе.

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

Общий ресурс оформления с приоритетом над соответствующими theme-значениями; null возвращает оформление к теме. Изменения ресурса инвалидируют шейпинг всех использующих его Label. Если Font ресурса отсутствует, возможен шрифт темы.

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

Язык обработки текста этого Label. Не меняет глобальную локаль TranslationServer и не выбирает другой каталог перевода. Выбор перевода и обработку символов проверяйте отдельно.

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

Неотрицательное число пропускаемых строк, 0 по умолчанию. Не удаляет символы из Text; влияет на окно рисования и CharacterBounds.

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

Ограничение числа отображаемых строк, -1 для отсутствия ограничения. Не равно GetLineCount и не удаляет Text. Доступная высота всё ещё может ограничить результат.

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

Верхняя граница подбора, 60 по умолчанию. Не ограничивает обычный theme/LabelSettings размер при выключенном ResizeFontToFit. Обеспечьте положительное maximum ≥ minimum.

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

Нижняя граница подбора и его минимального вертикального размера, 10 по умолчанию. Проверяйте 1 ≤ minimum ≤ maximum сами: setter не ограничивает число.

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

Разделитель абзацев с c_unescape; строка \n по умолчанию означает перевод строки. Не является регулярным выражением и не задаёт расстояние между абзацами.

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

Подбирать размер между MinimumFontSize/MaximumFontSize по ширине и высоте области, false по умолчанию. Подбор может увеличить и уменьшить размер. Если даже minimum не помещается, обрезание всё ещё возможно.

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

Структурированный BiDi-парсер для URI, файловых путей и других смешанных направлений. Обрабатывает текст, не открывает адрес и не выполняет перевод.

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

Общий Array параметров BiDi-парсера. Alias-изменения не инвалидируют шейпинг; повторная запись того же массива также может ничего не обновить. Скопируйте массив до изменения и назначьте новую версию.

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

Массив позиций табуляции в пикселях. C# float[] копируется при чтении и передаче; измените копию и присвойте обратно. Это не число пробелов и не размеры колонок контейнера.

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

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

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

Направление обработки текста, Auto по умолчанию. Inherited берёт направление раскладки Control. Не заменяет LayoutDirection для положения строк и GlyphsAuto.

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

Сокращение при нехватке места, NoTrimming по умолчанию. Выберите TrimChar/TrimWord или подходящий Ellipsis-вариант. Не меняет исходный Text; результат зависит от переноса, области и числа видимых строк.

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

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

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

Top/Center/Bottom/Fill внутри области, Top по умолчанию. Не заменяет LinesSkipped и не меняет родительскую раскладку Control.

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

Число позиций для появления: -1 — все, иначе используйте 0…GetTotalCharacterCount. Не является числом C# char или графем; смысл зависит от VisibleCharactersBehavior. Избыточное число не ограничивается и может вывести VisibleRatio за 1.

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

CharsBeforeShaping по умолчанию обрезает вход до подготовки; CharsAfterShaping сохраняет полную раскладку. GlyphsAuto/Ltr/Rtl раскрывают глифы по направлению, не целые пользовательские текстовые элементы.

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

Доля появления, 1 по умолчанию. Изменённая доля ≥1 показывает всё, отрицательная даёт 0, промежуточная округляет число позиций вниз. Если через VisibleCharacters уже сохранено то же значение за пределами диапазона, повторная запись не нормализует его. Передавайте конечные 0…1.

Методы57

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

Перенос, Off по умолчанию. WordSmart переносит слова и разбивает длинные фрагменты, Arbitrary использует границы графем. Нужна ограниченная ширина; добавьте положительный минимум или максимум ширины для устойчивой раскладки.

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

Сохранённая настройка AutowrapMode.

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

Удаление краевых пробелов строк, по умолчанию TrimStartEdgeSpaces | TrimEndEdgeSpaces. Остальные биты LineBreakFlag отбрасываются; они не задают режим переноса.

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

Сохранённая настройка AutowrapTrimFlags.

GetCharacterBoundsRect2
# GetCharacterBounds
C#
public Rect2 GetCharacterBounds(int pos);

Локальная рамка продвижения кластера для позиции кодовой точки. Учитывает раскладку и пропуск строк; несколько позиций могут иметь общую рамку. Пустой Rect2 означает отсутствие соответствующей рамки, не обязательно ошибку. Это не tight bounds пикселей.

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

Позиция кодовой точки в обрабатываемом тексте, не C# UTF-16 индекс.

Возвращает Rect2

Локальный Rect2 кластера либо пустой Rect2.

GetEllipsisCharstring
# GetEllipsisChar
C#
public string GetEllipsisChar();

Символ сокращения, … по умолчанию. Используйте один Unicode-символ; более длинная строка предупреждает и сокращается до первого. Не включает TextOverrunBehavior автоматически.

Возвращает string

Сохранённая настройка EllipsisChar.

GetHorizontalAlignmentHorizontalAlignment
# GetHorizontalAlignment
C#
public HorizontalAlignment GetHorizontalAlignment();

Left/Center/Right/Fill для текста внутри области, Left по умолчанию. Left/Right учитывают RTL LayoutDirection; Fill использует JustificationFlags. Не перемещает сам Control.

Возвращает HorizontalAlignment

Сохранённая настройка HorizontalAlignment.

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

Флаги растяжения текста для HorizontalAlignment = Fill, включая границы слов, кашиду и правила последней строки. Не включают Fill сами по себе.

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

Сохранённая настройка JustificationFlags.

GetLabelSettingsLabelSettings
# GetLabelSettings
C#
public LabelSettings GetLabelSettings();

Общий ресурс оформления с приоритетом над соответствующими theme-значениями; null возвращает оформление к теме. Изменения ресурса инвалидируют шейпинг всех использующих его Label. Если Font ресурса отсутствует, возможен шрифт темы.

Возвращает LabelSettings

Общий LabelSettings либо null.

GetLanguagestring
# GetLanguage
C#
public string GetLanguage();

Язык шейпинга и преобразования регистра; пустая строка использует локаль Control. Не переключает язык приложения и не возвращает перевод из GetText.

Возвращает string

Сохранённый код языка либо пустая строка для локали Control.

GetLineCountint
# GetLineCount
C#
public int GetLineCount();

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

Возвращает int

Число строк подготовленного текста; вне дерева 1.

GetLineHeightint
# GetLineHeight
C#
public int GetLineHeight(int line = -1);

Высота подготовленной строки в пикселях. Для -1 или индекса вне диапазона возвращает максимальную высоту строк/шрифта, а не ошибку. Перед измерением подготовьте раскладку через GetLineCount.

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

Индекс подготовленной строки; -1 по умолчанию возвращает максимальную высоту.

Возвращает int

Высота строки либо максимальная высота для -1/индекса вне диапазона.

GetLinesSkippedint
# GetLinesSkipped
C#
public int GetLinesSkipped();

Неотрицательное число пропускаемых строк, 0 по умолчанию. Не удаляет символы из Text; влияет на окно рисования и CharacterBounds.

Возвращает int

Число пропускаемых строк.

GetMaxLinesVisibleint
# GetMaxLinesVisible
C#
public int GetMaxLinesVisible();

Ограничение числа отображаемых строк, -1 для отсутствия ограничения. Не равно GetLineCount и не удаляет Text. Доступная высота всё ещё может ограничить результат.

Возвращает int

Ограничение строк; -1 означает отсутствие ограничения.

GetMaximumFontSizeint
# GetMaximumFontSize
C#
public int GetMaximumFontSize();

Верхняя граница подбора, 60 по умолчанию. Не ограничивает обычный theme/LabelSettings размер при выключенном ResizeFontToFit. Обеспечьте положительное maximum ≥ minimum.

Возвращает int

Сохранённая верхняя граница подбора размера.

GetMinimumFontSizeint
# GetMinimumFontSize
C#
public int GetMinimumFontSize();

Нижняя граница подбора и его минимального вертикального размера, 10 по умолчанию. Проверяйте 1 ≤ minimum ≤ maximum сами: setter не ограничивает число.

Возвращает int

Сохранённая нижняя граница подбора размера.

GetParagraphSeparatorstring
# GetParagraphSeparator
C#
public string GetParagraphSeparator();

Разделитель абзацев с c_unescape; строка \n по умолчанию означает перевод строки. Не является регулярным выражением и не задаёт расстояние между абзацами.

Возвращает string

Сохранённая строка разделителя до c_unescape.

GetRenderedFontSizeint
# GetRenderedFontSize
C#
public int GetRenderedFontSize();

Последний рассчитанный размер шрифта или базовый размер. Getter сам не запускает новый подбор: после изменения области/настроек сначала вызовите GetLineCount/GetMinimumSize.

Возвращает int

Текущий кэшированный или базовый размер шрифта.

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

Структурированный BiDi-парсер для URI, файловых путей и других смешанных направлений. Обрабатывает текст, не открывает адрес и не выполняет перевод.

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

Сохранённая настройка StructuredTextBidiOverride.

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

Общий Array параметров BiDi-парсера. Alias-изменения не инвалидируют шейпинг; повторная запись того же массива также может ничего не обновить. Скопируйте массив до изменения и назначьте новую версию.

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

Общий Array параметров, не независимая копия.

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

Массив позиций табуляции в пикселях. C# float[] копируется при чтении и передаче; измените копию и присвойте обратно. Это не число пробелов и не размеры колонок контейнера.

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

Копия C# float[] позиций табуляции.

GetTextstring
# GetText
C#
public string GetText();

Исходный обычный текст, не BBCode. Getter возвращает исходник, тогда как подсчёт символов использует переведённую строку. При частичном VisibleRatio замена текста пересчитывает VisibleCharacters по сохранённой доле.

Возвращает string

Исходная строка до перевода/Uppercase/появления.

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

Направление обработки текста, Auto по умолчанию. Inherited берёт направление раскладки Control. Не заменяет LayoutDirection для положения строк и GlyphsAuto.

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

Сохранённая настройка TextDirection.

GetTextOverrunBehaviorTextServer.OverrunBehavior
# GetTextOverrunBehavior
C#
public TextServer.OverrunBehavior GetTextOverrunBehavior();

Сокращение при нехватке места, NoTrimming по умолчанию. Выберите TrimChar/TrimWord или подходящий Ellipsis-вариант. Не меняет исходный Text; результат зависит от переноса, области и числа видимых строк.

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

Сохранённая настройка TextOverrunBehavior.

GetTotalCharacterCountint
# GetTotalCharacterCount
C#
public int GetTotalCharacterCount();

Возвращает длину внутреннего переведённого текста Label. Может отличаться от длины Text, который сохраняет исходный ключ. Это не число отрисованных глифов и не проверка отсутствия обрезки.

Возвращает int

Длина внутреннего текста после автоматического перевода; не размер исходного ключа и не число видимых строк.

GetVerticalAlignmentVerticalAlignment
# GetVerticalAlignment
C#
public VerticalAlignment GetVerticalAlignment();

Top/Center/Bottom/Fill внутри области, Top по умолчанию. Не заменяет LinesSkipped и не меняет родительскую раскладку Control.

Возвращает VerticalAlignment

Сохранённая настройка VerticalAlignment.

GetVisibleCharactersint
# GetVisibleCharacters
C#
public int GetVisibleCharacters();

Число позиций для появления: -1 — все, иначе используйте 0…GetTotalCharacterCount. Не является числом C# char или графем; смысл зависит от VisibleCharactersBehavior. Избыточное число не ограничивается и может вывести VisibleRatio за 1.

Возвращает int

Сохранённое число позиций; -1 означает все.

GetVisibleCharactersBehaviorTextServer.VisibleCharactersBehavior
# GetVisibleCharactersBehavior
C#
public TextServer.VisibleCharactersBehavior GetVisibleCharactersBehavior();

CharsBeforeShaping по умолчанию обрезает вход до подготовки; CharsAfterShaping сохраняет полную раскладку. GlyphsAuto/Ltr/Rtl раскрывают глифы по направлению, не целые пользовательские текстовые элементы.

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

Сохранённая настройка VisibleCharactersBehavior.

GetVisibleLineCountint
# GetVisibleLineCount
C#
public int GetVisibleLineCount();

Считает помещающиеся строки подготовленной раскладки с LinesSkipped/MaxLinesVisible и высотой. Сам не запускает шейпинг: после изменения сначала вызовите GetLineCount/GetMinimumSize. Не считает реально раскрытые глифы.

Возвращает int

Число помещающихся строк из текущего кэша раскладки.

GetVisibleRatiofloat
# GetVisibleRatio
C#
public float GetVisibleRatio();

Доля появления, 1 по умолчанию. Изменённая доля ≥1 показывает всё, отрицательная даёт 0, промежуточная округляет число позиций вниз. Если через VisibleCharacters уже сохранено то же значение за пределами диапазона, повторная запись не нормализует его. Передавайте конечные 0…1.

Возвращает float

Сохранённая доля; запись VisibleCharacters может вывести её за 0…1.

IsClippingTextbool
# IsClippingText
C#
public bool IsClippingText();

Обрезание по области, false по умолчанию. Снимает естественную ширину текста из минимума; не включает многоточие автоматически и не отменяет CustomMinimumSize/поля стиля.

Возвращает bool

Сохранённая настройка ClipText.

IsResizeFontToFitEnabledbool
# IsResizeFontToFitEnabled
C#
public bool IsResizeFontToFitEnabled();

Подбирать размер между MinimumFontSize/MaximumFontSize по ширине и высоте области, false по умолчанию. Подбор может увеличить и уменьшить размер. Если даже minimum не помещается, обрезание всё ещё возможно.

Возвращает bool

Сохранённая настройка ResizeFontToFit.

IsUppercasebool
# IsUppercase
C#
public bool IsUppercase();

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

Возвращает bool

Сохранённая настройка Uppercase.

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

Перенос, Off по умолчанию. WordSmart переносит слова и разбивает длинные фрагменты, Arbitrary использует границы графем. Нужна ограниченная ширина; добавьте положительный минимум или максимум ширины для устойчивой раскладки.

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

Перенос, Off по умолчанию. WordSmart переносит слова и разбивает длинные фрагменты, Arbitrary использует границы графем. Нужна ограниченная ширина; добавьте положительный минимум или максимум ширины для устойчивой раскладки.

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

Удаление краевых пробелов строк, по умолчанию TrimStartEdgeSpaces | TrimEndEdgeSpaces. Остальные биты LineBreakFlag отбрасываются; они не задают режим переноса.

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

Удаление краевых пробелов строк, по умолчанию TrimStartEdgeSpaces | TrimEndEdgeSpaces. Остальные биты LineBreakFlag отбрасываются; они не задают режим переноса.

SetClipTextvoid
# SetClipText
C#
public void SetClipText(bool enable);

Обрезание по области, false по умолчанию. Снимает естественную ширину текста из минимума; не включает многоточие автоматически и не отменяет CustomMinimumSize/поля стиля.

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

Обрезание по области, false по умолчанию. Снимает естественную ширину текста из минимума; не включает многоточие автоматически и не отменяет CustomMinimumSize/поля стиля.

SetEllipsisCharvoid
# SetEllipsisChar
C#
public void SetEllipsisChar(string @char);

Символ сокращения, … по умолчанию. Используйте один Unicode-символ; более длинная строка предупреждает и сокращается до первого. Не включает TextOverrunBehavior автоматически.

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

Символ сокращения, … по умолчанию. Используйте один Unicode-символ; более длинная строка предупреждает и сокращается до первого. Не включает TextOverrunBehavior автоматически.

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

Left/Center/Right/Fill для текста внутри области, Left по умолчанию. Left/Right учитывают RTL LayoutDirection; Fill использует JustificationFlags. Не перемещает сам Control.

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

Left/Center/Right/Fill для текста внутри области, Left по умолчанию. Left/Right учитывают RTL LayoutDirection; Fill использует JustificationFlags. Не перемещает сам Control.

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

Флаги растяжения текста для HorizontalAlignment = Fill, включая границы слов, кашиду и правила последней строки. Не включают Fill сами по себе.

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

Флаги растяжения текста для HorizontalAlignment = Fill, включая границы слов, кашиду и правила последней строки. Не включают Fill сами по себе.

SetLabelSettingsvoid
# SetLabelSettings
C#
public void SetLabelSettings(LabelSettings settings);

Общий ресурс оформления с приоритетом над соответствующими theme-значениями; null возвращает оформление к теме. Изменения ресурса инвалидируют шейпинг всех использующих его Label. Если Font ресурса отсутствует, возможен шрифт темы.

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

Общий ресурс оформления с приоритетом над соответствующими theme-значениями; null возвращает оформление к теме. Изменения ресурса инвалидируют шейпинг всех использующих его Label. Если Font ресурса отсутствует, возможен шрифт темы.

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

Язык шейпинга и преобразования регистра; пустая строка использует локаль Control. Не переключает язык приложения и не возвращает перевод из GetText.

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

Язык шейпинга и преобразования регистра; пустая строка использует локаль Control. Не переключает язык приложения и не возвращает перевод из GetText.

SetLinesSkippedvoid
# SetLinesSkipped
C#
public void SetLinesSkipped(int linesSkipped);

Неотрицательное число пропускаемых строк, 0 по умолчанию. Не удаляет символы из Text; влияет на окно рисования и CharacterBounds.

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

Неотрицательное число пропускаемых строк, 0 по умолчанию. Не удаляет символы из Text; влияет на окно рисования и CharacterBounds.

SetMaxLinesVisiblevoid
# SetMaxLinesVisible
C#
public void SetMaxLinesVisible(int linesVisible);

Ограничение числа отображаемых строк, -1 для отсутствия ограничения. Не равно GetLineCount и не удаляет Text. Доступная высота всё ещё может ограничить результат.

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

Ограничение числа отображаемых строк, -1 для отсутствия ограничения. Не равно GetLineCount и не удаляет Text. Доступная высота всё ещё может ограничить результат.

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

Верхняя граница подбора, 60 по умолчанию. Не ограничивает обычный theme/LabelSettings размер при выключенном ResizeFontToFit. Обеспечьте положительное maximum ≥ minimum.

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

Верхняя граница подбора, 60 по умолчанию. Не ограничивает обычный theme/LabelSettings размер при выключенном ResizeFontToFit. Обеспечьте положительное maximum ≥ minimum.

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

Нижняя граница подбора и его минимального вертикального размера, 10 по умолчанию. Проверяйте 1 ≤ minimum ≤ maximum сами: setter не ограничивает число.

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

Нижняя граница подбора и его минимального вертикального размера, 10 по умолчанию. Проверяйте 1 ≤ minimum ≤ maximum сами: setter не ограничивает число.

SetParagraphSeparatorvoid
# SetParagraphSeparator
C#
public void SetParagraphSeparator(string paragraphSeparator);

Разделитель абзацев с c_unescape; строка \n по умолчанию означает перевод строки. Не является регулярным выражением и не задаёт расстояние между абзацами.

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

Разделитель абзацев с c_unescape; строка \n по умолчанию означает перевод строки. Не является регулярным выражением и не задаёт расстояние между абзацами.

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

Подбирать размер между MinimumFontSize/MaximumFontSize по ширине и высоте области, false по умолчанию. Подбор может увеличить и уменьшить размер. Если даже minimum не помещается, обрезание всё ещё возможно.

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

Подбирать размер между MinimumFontSize/MaximumFontSize по ширине и высоте области, false по умолчанию. Подбор может увеличить и уменьшить размер. Если даже minimum не помещается, обрезание всё ещё возможно.

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

Структурированный BiDi-парсер для URI, файловых путей и других смешанных направлений. Обрабатывает текст, не открывает адрес и не выполняет перевод.

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

Структурированный BiDi-парсер для URI, файловых путей и других смешанных направлений. Обрабатывает текст, не открывает адрес и не выполняет перевод.

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

Общий Array параметров BiDi-парсера. Alias-изменения не инвалидируют шейпинг; повторная запись того же массива также может ничего не обновить. Скопируйте массив до изменения и назначьте новую версию.

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

Общий Array параметров BiDi-парсера. Alias-изменения не инвалидируют шейпинг; повторная запись того же массива также может ничего не обновить. Скопируйте массив до изменения и назначьте новую версию.

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

Массив позиций табуляции в пикселях. C# float[] копируется при чтении и передаче; измените копию и присвойте обратно. Это не число пробелов и не размеры колонок контейнера.

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

Массив позиций табуляции в пикселях. C# float[] копируется при чтении и передаче; измените копию и присвойте обратно. Это не число пробелов и не размеры колонок контейнера.

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

Массив позиций табуляции в пикселях. C# float[] копируется при чтении и передаче; измените копию и присвойте обратно. Это не число пробелов и не размеры колонок контейнера.

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

Массив позиций табуляции в пикселях. C# float[] копируется при чтении и передаче; измените копию и присвойте обратно. Это не число пробелов и не размеры колонок контейнера.

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

Исходный обычный текст, не BBCode. Getter возвращает исходник, тогда как подсчёт символов использует переведённую строку. При частичном VisibleRatio замена текста пересчитывает VisibleCharacters по сохранённой доле.

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

Исходный обычный текст, не BBCode. Getter возвращает исходник, тогда как подсчёт символов использует переведённую строку. При частичном VisibleRatio замена текста пересчитывает VisibleCharacters по сохранённой доле.

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

Направление обработки текста, Auto по умолчанию. Inherited берёт направление раскладки Control. Не заменяет LayoutDirection для положения строк и GlyphsAuto.

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

Направление обработки текста, Auto по умолчанию. Inherited берёт направление раскладки Control. Не заменяет LayoutDirection для положения строк и GlyphsAuto.

SetTextOverrunBehaviorvoid
# SetTextOverrunBehavior
C#
public void SetTextOverrunBehavior(TextServer.OverrunBehavior overrunBehavior);

Сокращение при нехватке места, NoTrimming по умолчанию. Выберите TrimChar/TrimWord или подходящий Ellipsis-вариант. Не меняет исходный Text; результат зависит от переноса, области и числа видимых строк.

Параметры
ИмяТипПо умолчанию
overrunBehaviorTextServer.OverrunBehavior—
overrunBehavior

Сокращение при нехватке места, NoTrimming по умолчанию. Выберите TrimChar/TrimWord или подходящий Ellipsis-вариант. Не меняет исходный Text; результат зависит от переноса, области и числа видимых строк.

SetUppercasevoid
# SetUppercase
C#
public void SetUppercase(bool enable);

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

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

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

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

Top/Center/Bottom/Fill внутри области, Top по умолчанию. Не заменяет LinesSkipped и не меняет родительскую раскладку Control.

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

Top/Center/Bottom/Fill внутри области, Top по умолчанию. Не заменяет LinesSkipped и не меняет родительскую раскладку Control.

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

Число позиций для появления: -1 — все, иначе используйте 0…GetTotalCharacterCount. Не является числом C# char или графем; смысл зависит от VisibleCharactersBehavior. Избыточное число не ограничивается и может вывести VisibleRatio за 1.

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

Число позиций для появления: -1 — все, иначе используйте 0…GetTotalCharacterCount. Не является числом C# char или графем; смысл зависит от VisibleCharactersBehavior. Избыточное число не ограничивается и может вывести VisibleRatio за 1.

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

CharsBeforeShaping по умолчанию обрезает вход до подготовки; CharsAfterShaping сохраняет полную раскладку. GlyphsAuto/Ltr/Rtl раскрывают глифы по направлению, не целые пользовательские текстовые элементы.

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

CharsBeforeShaping по умолчанию обрезает вход до подготовки; CharsAfterShaping сохраняет полную раскладку. GlyphsAuto/Ltr/Rtl раскрывают глифы по направлению, не целые пользовательские текстовые элементы.

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

Доля появления, 1 по умолчанию. Изменённая доля ≥1 показывает всё, отрицательная даёт 0, промежуточная округляет число позиций вниз. Если через VisibleCharacters уже сохранено то же значение за пределами диапазона, повторная запись не нормализует его. Передавайте конечные 0…1.

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

Доля появления, 1 по умолчанию. Изменённая доля ≥1 показывает всё, отрицательная даёт 0, промежуточная округляет число позиций вниз. Если через VisibleCharacters уже сохранено то же значение за пределами диапазона, повторная запись не нормализует его. Передавайте конечные 0…1.

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

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

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

Color Label текста по умолчанию.

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

Цвет контура текста.

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

Color эффекта тени текста.

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

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

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

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

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

Вертикальный интервал между абзацами. Добавляется поверх Label.line_spacing.

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

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

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

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

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

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

По умолчанию: 1
font
Font

Font, используемый для текста Label-ов.

font_size
int

Font размер LabelЭто смс.

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

focus
StyleBox

StyleBox используется, когда фокус находится на Label (при использовании со вспомогательными приложениями).

normal
StyleBox

Фон StyleBox для Label.

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

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

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

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