Struct RichTextSpan

Namespace

Forma

Assembly

Forma.dll

A parsed run in a RichTextLabel document.

public readonly struct RichTextSpan

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

RichTextSpan(string, Color?, bool, bool, bool, bool)

public RichTextSpan(string text, Color? color, bool bold, bool italic, bool underline, bool strikethrough)

Parameters

text string

color Color?

bold bool

italic bool

underline bool

strikethrough bool

RichTextSpan(string, Color?, Color?, bool, bool, bool, bool, object)

public RichTextSpan(string text, Color? color, Color? backgroundColor, bool bold, bool italic, bool underline, bool strikethrough, object meta)

Parameters

text string

color Color?

backgroundColor Color?

bold bool

italic bool

underline bool

strikethrough bool

meta object

Properties

BackgroundColor

public Color? BackgroundColor { get; }

Property Value

Color?

Bold

public bool Bold { get; }

Property Value

bool

Color

public Color? Color { get; }

Property Value

Color?

Image

Optional inline texture added through AddImage(Texture2D, float, float, Color?, object, string).

public Texture2D Image { get; }

Property Value

Texture2D

ImageModulate

public Color ImageModulate { get; }

Property Value

Color

ImageSize

public Vector2 ImageSize { get; }

Property Value

Vector2

IsHorizontalRule

Whether this span is a paragraph-level horizontal rule created by AddHorizontalRule(int, int, Color?, HorizontalAlignment, bool, bool).

public bool IsHorizontalRule { get; }

Property Value

bool

Italic

public bool Italic { get; }

Property Value

bool

Meta

Godot-style metadata attached to this span (for example from [url] or [meta]).

public object Meta { get; }

Property Value

object

RuleAlignment

public HorizontalAlignment RuleAlignment { get; }

Property Value

HorizontalAlignment

RuleColor

public Color? RuleColor { get; }

Property Value

Color?

RuleHeight

public int RuleHeight { get; }

Property Value

int

RuleHeightInPercent

public bool RuleHeightInPercent { get; }

Property Value

bool

RuleWidth

public int RuleWidth { get; }

Property Value

int

RuleWidthInPercent

public bool RuleWidthInPercent { get; }

Property Value

bool

Strikethrough

public bool Strikethrough { get; }

Property Value

bool

Text

public string Text { get; }

Property Value

string

Underline

public bool Underline { get; }

Property Value

bool