Class RichTextBox

Rich text box control which can gather text input from the user and present text in highly formatted and stylized way.

System.IComparable
Namespace: FlaxEngine.GUI
Assembly: FlaxEngine.CSharp.dll
Syntax
[ActorToolbox("GUI")]
public class RichTextBox : RichTextBoxBase, IComparable, IDrawable

Constructors

RichTextBox()

Initializes a new instance of the RichTextBox class.

Declaration
public RichTextBox()

Fields

Images

The collection of custom images/sprites that can be inlined in text (named).

Declaration
[EditorOrder(40)]
public Dictionary<string, IBrush> Images
Field Value
System.Collections.Generic.Dictionary<System.String, IBrush>

Styles

The collection of custom text styles to apply (named).

Declaration
[EditorOrder(30)]
public Dictionary<string, TextBlockStyle> Styles
Field Value
System.Collections.Generic.Dictionary<System.String, TextBlockStyle>

TagProcessors

Collection of HTML tags processors.

Declaration
public static Dictionary<string, RichTextBox.ProcessTagDelegate> TagProcessors
Field Value
System.Collections.Generic.Dictionary<System.String, RichTextBox.ProcessTagDelegate>

Properties

TextStyle

The default text style applied to the whole text.

Declaration
[EditorOrder(20)]
public TextBlockStyle TextStyle { get; set; }
Property Value
TextBlockStyle

Methods

OnAddTextBlock(ref RichTextBox.ParsingContext, Int32, Int32)

Inserts parsed text block using the current style and state (eg. from tags).

Declaration
protected virtual void OnAddTextBlock(ref RichTextBox.ParsingContext context, int start, int end)
Parameters
RichTextBox.ParsingContext context

The parsing context.
System.Int32 start

Start position (character index).
System.Int32 end

End position (character index).

OnParseTag(ref RichTextBox.ParsingContext, ref HtmlTag)

Parses HTML tag.

Declaration
protected virtual void OnParseTag(ref RichTextBox.ParsingContext context, ref HtmlTag tag)
Parameters
RichTextBox.ParsingContext context

The parsing context.
HtmlTag tag

The tag.

OnParseTextBlocks()

Called when text blocks needs to be updated from the current text.

Declaration
protected override void OnParseTextBlocks()
Overrides

OnSizeChanged()

Called when control size gets changed.

Declaration
protected override void OnSizeChanged()
Overrides

Extension Methods