TextParagraph
Содержит абзац текста.
Содержит абзац текста.
Абстракция над TextServer для обработки одного абзаца текста.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Конструкторы1
TextParagraphКонструктор
public TextParagraph();Свойства13
AlignmentСвойство
public HorizontalAlignment Alignment { get; set; }Горизонтальное выравнивание абзаца.
BreakFlagsСвойство
public TextServer.LineBreakFlag BreakFlags { get; set; }Правила переноса строк. Для получения дополнительной информации см. TextServer.
CustomPunctuationСвойство
public string CustomPunctuation { get; set; }Пользовательский список знаков препинания, используемый для разбиения слов. Если задана пустая строка, используются значения сервера по умолчанию.
DirectionСвойство
public TextServer.Direction Direction { get; set; }Направление написания текста.
EllipsisCharСвойство
public string EllipsisChar { get; set; }Символ многоточия, используемый для обрезки текста.
JustificationFlagsСвойство
public TextServer.JustificationFlag JustificationFlags { get; set; }Правила выравнивания заливки линий.
LineSpacingСвойство
public float LineSpacing { get; set; }Дополнительный вертикальный интервал между строками (в пикселях), интервал добавляется к спуску строки. Это значение может быть отрицательным.
MaxLinesVisibleСвойство
public int MaxLinesVisible { get; set; }Ограничивает количество отображаемых строк текста.
OrientationСвойство
public TextServer.Orientation Orientation { get; set; }Ориентация текста.
PreserveControlСвойство
public bool PreserveControl { get; set; }Если установлено значение true, текст будет отображать управляющие символы.
PreserveInvalidСвойство
public bool PreserveInvalid { get; set; }Если установлено значение true, в тексте будут отображаться недопустимые символы.
TextOverrunBehaviorСвойство
public TextServer.OverrunBehavior TextOverrunBehavior { get; set; }Поведение обрезки, когда текст превышает заданную ширину абзаца.
WidthСвойство
public float Width { get; set; }Ширина абзаца.
Методы69
AddObjectbool
public bool AddObject(Variant key, Vector2 size, InlineAlignment inlineAlign = InlineAlignment.Center, int length = 1, float baseline = 0f);Добавляет встроенный объект в текстовый буфер, key должен быть уникальным. В тексте объект представлен как length символов замены объекта.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
size | Vector2 | — |
inlineAlign | InlineAlignment | InlineAlignment.Center |
length | int | 1 |
baseline | float | 0f |
boolAddStringbool
public bool AddString(string text, Font font, int fontSize, string language = "", Variant meta = default);Добавляет текстовый диапазон и шрифт для его отрисовки.
| Имя | Тип | По умолчанию |
|---|---|---|
text | string | — |
font | Font | — |
fontSize | int | — |
language | string | "" |
meta | Variant | default |
boolClearvoid
public void Clear();Очищает текстовый абзац (удаляет текст и встроенные объекты).
ClearDropcapvoid
public void ClearDropcap();Удаляет начальную букву капитель (dropcap).
Draw2 перегрузки
public void Draw(Rid canvas, Vector2 pos, Color? color, Color? dcColor);Нарисуйте все строки текста и буквицы в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
color | Color? | — |
dcColor | Color? | — |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
dcColorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
public void Draw(Rid canvas, Vector2 pos, Color? color = default, Color? dcColor = default, float oversampling = 0f);Нарисуйте все строки текста и буквицы в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
color | Color? | default |
dcColor | Color? | default |
oversampling | float | 0f |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
dcColorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
DrawDropcap2 перегрузки
public void DrawDropcap(Rid canvas, Vector2 pos, Color? color);Нарисуйте буквицу в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
color | Color? | — |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
public void DrawDropcap(Rid canvas, Vector2 pos, Color? color = default, float oversampling = 0f);Нарисуйте буквицу в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
color | Color? | default |
oversampling | float | 0f |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
DrawDropcapOutline2 перегрузки
public void DrawDropcapOutline(Rid canvas, Vector2 pos, int outlineSize, Color? color);Нарисуйте контур буквицы в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
outlineSize | int | — |
color | Color? | — |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
public void DrawDropcapOutline(Rid canvas, Vector2 pos, int outlineSize = 1, Color? color = default, float oversampling = 0f);Нарисуйте контур буквицы в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
outlineSize | int | 1 |
color | Color? | default |
oversampling | float | 0f |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
DrawLine2 перегрузки
public void DrawLine(Rid canvas, Vector2 pos, int line, Color? color);Нарисуйте одну строку текста в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
line | int | — |
color | Color? | — |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
public void DrawLine(Rid canvas, Vector2 pos, int line, Color? color = default, float oversampling = 0f);Нарисуйте одну строку текста в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
line | int | — |
color | Color? | default |
oversampling | float | 0f |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
DrawLineOutline2 перегрузки
public void DrawLineOutline(Rid canvas, Vector2 pos, int line, int outlineSize, Color? color);Нарисовать контур одной строки текста в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
line | int | — |
outlineSize | int | — |
color | Color? | — |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
public void DrawLineOutline(Rid canvas, Vector2 pos, int line, int outlineSize = 1, Color? color = default, float oversampling = 0f);Нарисовать контур одной строки текста в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
line | int | — |
outlineSize | int | 1 |
color | Color? | default |
oversampling | float | 0f |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
DrawOutline2 перегрузки
public void DrawOutline(Rid canvas, Vector2 pos, int outlineSize, Color? color, Color? dcColor);Нарисовать контуры всех строк текста и буквицы в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
outlineSize | int | — |
color | Color? | — |
dcColor | Color? | — |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
dcColorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
public void DrawOutline(Rid canvas, Vector2 pos, int outlineSize = 1, Color? color = default, Color? dcColor = default, float oversampling = 0f);Нарисовать контуры всех строк текста и буквицы в элементе холста в заданной позиции с color. pos указывает верхний левый угол ограничивающего прямоугольника. Если oversampling больше нуля, он используется как фактор передискретизации шрифта, в противном случае используются настройки передискретизации области просмотра.
| Имя | Тип | По умолчанию |
|---|---|---|
canvas | Rid | — |
pos | Vector2 | — |
outlineSize | int | 1 |
color | Color? | default |
dcColor | Color? | default |
oversampling | float | 0f |
colorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
dcColorЕсли параметр не имеет значения, то значение по умолчанию: new Color(1.0f, 1.0f, 1.0f, 1.0f).
DuplicateTextParagraph
public TextParagraph Duplicate();Дублирует этот TextParagraph.
TextParagraphGetAlignmentHorizontalAlignment
public HorizontalAlignment GetAlignment();HorizontalAlignmentGetBreakFlagsTextServer.LineBreakFlag
public TextServer.LineBreakFlag GetBreakFlags();TextServer.LineBreakFlagGetCustomPunctuationstring
public string GetCustomPunctuation();stringGetDirectionTextServer.Direction
public TextServer.Direction GetDirection();TextServer.DirectionGetDropcapLinesint
public int GetDropcapLines();Возвращает количество строк, используемых в dropcap (буквицей).
intGetDropcapRidRid
public Rid GetDropcapRid();Возвращает RID текстового буфера буквицы.
RidGetDropcapSizeVector2
public Vector2 GetDropcapSize();Возвращает размер ограничивающего прямоугольника буквицы.
Vector2GetEllipsisCharstring
public string GetEllipsisChar();stringGetInferredDirectionTextServer.Direction
public TextServer.Direction GetInferredDirection();Возвращает направление написания текста, выведенное алгоритмом BiDi.
TextServer.DirectionGetJustificationFlagsTextServer.JustificationFlag
public TextServer.JustificationFlag GetJustificationFlags();TextServer.JustificationFlagGetLineAscentfloat
public float GetLineAscent(int line);Возвращает высоту текстовой строки (количество пикселей над базовой линией для горизонтальной компоновки или слева от базовой линии для вертикальной).
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
floatGetLineCountint
public int GetLineCount();Возвращает количество строк в абзаце.
intGetLineDescentfloat
public float GetLineDescent(int line);Возвращает смещение текстовой строки (количество пикселей ниже базовой линии для горизонтальной компоновки или справа от базовой линии для вертикальной).
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
floatGetLineObjectRectRect2
public Rect2 GetLineObjectRect(int line, Variant key);Возвращает ограничивающий прямоугольник встроенного объекта.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
key | Variant | — |
Rect2GetLineObjectsReckfell.Collections.Array
public Reckfell.Collections.Array GetLineObjects(int line);Возвращает массив встроенных объектов в строке.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
Reckfell.Collections.ArrayGetLineRangeVector2I
public Vector2I GetLineRange(int line);Возвращает диапазон символов строки.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
Vector2IGetLineRidRid
public Rid GetLineRid(int line);Возвращает RID буфера строки TextServer.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
RidGetLineSizeVector2
public Vector2 GetLineSize(int line);Возвращает размер ограничивающего прямоугольника строки текста. Возвращаемый размер округляется в большую сторону.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
Vector2GetLineSpacingfloat
public float GetLineSpacing();floatGetLineUnderlinePositionfloat
public float GetLineUnderlinePosition(int line);Возвращает смещение подчеркивания в пикселях относительно базовой линии.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
floatGetLineUnderlineThicknessfloat
public float GetLineUnderlineThickness(int line);Возвращает толщину подчеркивания.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
floatGetLineWidthfloat
public float GetLineWidth(int line);Возвращает ширину (для горизонтального расположения) или высоту (для вертикального расположения) строки текста.
| Имя | Тип | По умолчанию |
|---|---|---|
line | int | — |
floatGetMaxLinesVisibleint
public int GetMaxLinesVisible();intGetNonWrappedSizeVector2
public Vector2 GetNonWrappedSize();Возвращает размер ограничивающей рамки абзаца без переносов строк.
Vector2GetOrientationTextServer.Orientation
public TextServer.Orientation GetOrientation();TextServer.OrientationGetPreserveControlbool
public bool GetPreserveControl();boolGetPreserveInvalidbool
public bool GetPreserveInvalid();boolGetRangeVector2I
public Vector2I GetRange();Возвращает диапазон символов абзаца/параграфа.
Vector2IGetRidRid
public Rid GetRid();Возвращает полный строковый буфер RID TextServer.
RidGetSizeVector2
public Vector2 GetSize();Возвращает размер ограничивающей рамки абзаца.
Vector2GetTextOverrunBehaviorTextServer.OverrunBehavior
public TextServer.OverrunBehavior GetTextOverrunBehavior();TextServer.OverrunBehaviorGetWidthfloat
public float GetWidth();floatHasObjectbool
public bool HasObject(Variant key);Возвращает true, если объект с key встроен в этот текстовый буфер заданной формы.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
boolHitTestint
public int HitTest(Vector2 coords);Возвращает смещение символа каретки в указанных координатах. Эта функция всегда возвращает допустимую позицию.
| Имя | Тип | По умолчанию |
|---|---|---|
coords | Vector2 | — |
intResizeObjectbool
public bool ResizeObject(Variant key, Vector2 size, InlineAlignment inlineAlign = InlineAlignment.Center, float baseline = 0f);Устанавливает новый размер и выравнивание внедренного объекта.
| Имя | Тип | По умолчанию |
|---|---|---|
key | Variant | — |
size | Vector2 | — |
inlineAlign | InlineAlignment | InlineAlignment.Center |
baseline | float | 0f |
boolSetAlignmentvoid
public void SetAlignment(HorizontalAlignment alignment);| Имя | Тип | По умолчанию |
|---|---|---|
alignment | HorizontalAlignment | — |
SetBidiOverridevoid
public void SetBidiOverride(Reckfell.Collections.Array @override);Переопределяет BiDi для структурированного текста. Диапазоны переопределения должны охватывать весь исходный текст без перекрытий. Алгоритм BiDi будет использоваться для каждого диапазона отдельно.
| Имя | Тип | По умолчанию |
|---|---|---|
override | Reckfell.Collections.Array | — |
SetBreakFlagsvoid
public void SetBreakFlags(TextServer.LineBreakFlag flags);| Имя | Тип | По умолчанию |
|---|---|---|
flags | TextServer.LineBreakFlag | — |
SetCustomPunctuationvoid
public void SetCustomPunctuation(string customPunctuation);| Имя | Тип | По умолчанию |
|---|---|---|
customPunctuation | string | — |
SetDirectionvoid
public void SetDirection(TextServer.Direction direction);| Имя | Тип | По умолчанию |
|---|---|---|
direction | TextServer.Direction | — |
SetDropcapbool
public bool SetDropcap(string text, Font font, int fontSize, Rect2? dropcapMargins = default, string language = "");Устанавливает буквицу, переопределяет ранее установленную буквицу. Буквица — декоративный элемент в начале абзаца, который больше остального текста.
| Имя | Тип | По умолчанию |
|---|---|---|
text | string | — |
font | Font | — |
fontSize | int | — |
dropcapMargins | Rect2? | default |
language | string | "" |
dropcapMarginsЕсли параметр не имеет значения, то значение по умолчанию: new Rect2(new Vector2(0.0f, 0.0f), new Vector2(0.0f, 0.0f)).
boolSetEllipsisCharvoid
public void SetEllipsisChar(string @char);| Имя | Тип | По умолчанию |
|---|---|---|
char | string | — |
SetJustificationFlagsvoid
public void SetJustificationFlags(TextServer.JustificationFlag flags);| Имя | Тип | По умолчанию |
|---|---|---|
flags | TextServer.JustificationFlag | — |
SetLineSpacingvoid
public void SetLineSpacing(float lineSpacing);| Имя | Тип | По умолчанию |
|---|---|---|
lineSpacing | float | — |
SetMaxLinesVisiblevoid
public void SetMaxLinesVisible(int maxLinesVisible);| Имя | Тип | По умолчанию |
|---|---|---|
maxLinesVisible | int | — |
SetOrientationvoid
public void SetOrientation(TextServer.Orientation orientation);| Имя | Тип | По умолчанию |
|---|---|---|
orientation | TextServer.Orientation | — |
SetPreserveControlvoid
public void SetPreserveControl(bool enabled);| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
SetPreserveInvalidvoid
public void SetPreserveInvalid(bool enabled);| Имя | Тип | По умолчанию |
|---|---|---|
enabled | bool | — |
SetTextOverrunBehaviorvoid
public void SetTextOverrunBehavior(TextServer.OverrunBehavior overrunBehavior);| Имя | Тип | По умолчанию |
|---|---|---|
overrunBehavior | TextServer.OverrunBehavior | — |
SetWidthvoid
public void SetWidth(float width);| Имя | Тип | По умолчанию |
|---|---|---|
width | float | — |
TabAlign2 перегрузки
public void TabAlign(ReadOnlySpan<float> tabStops);Выравнивает абзац по указанным позициям табуляции.
| Имя | Тип | По умолчанию |
|---|---|---|
tabStops | ReadOnlySpan<float> | — |
public void TabAlign(float[] tabStops);Выравнивает абзац по указанным позициям табуляции.
| Имя | Тип | По умолчанию |
|---|---|---|
tabStops | float[] | — |