FastColoredTextBox: How add large text - similar to StringBuilder but using styles - and without building undo history

Question

FastColoredTextBox (FCTB) does provide StringBuilder-like methods, for example there is

public virtual void AppendText(string text, Style style)

and similar methods. However, it treats each of these as user input: each action is added to the undo history.

I am building my text programmatically, it is data fields and text, along with all the formatting and styles, and it gets large. At the end I throw away that undo history (or set the control to read only). A lot is wasted in memory and computation time. It takes a few seconds before the control is usable.

So is there a way to build my text before passing it to the FCTB?

Kay Zed · Accepted Answer · 2023-03-17T17:33:10.657

Create a TextSource-derived class:

public class TextBuilder : TextSource
{
    public Line CurrentLine { get; private set; }

    public TextBuilder(FastColoredTextBox t) : base(t)
    {
        AppendLine();
    }

    public void Append(string text, StyleIndex style = StyleIndex.None)
    {
        for (int i = 0; i < text.Length; i++)
        {
            char c = text[i];
            if (c == '\r' && i < text.Length - 1 && text[i + 1] == '\n') continue;
            if (c == '\r' || c == '\n') { AppendLine(); continue; }
            CurrentLine.Add(new Char(c, style));
        }
    }

    public void AppendLine(string text, StyleIndex style = StyleIndex.None)
    {
        Append(text, style);
        AppendLine();
    }

    public void AppendLine()
    {
        CurrentLine = CreateLine();
        lines.Add(CurrentLine);
    }

    public override void Initialized()
    {
        // Solution similar to CustomTextSourceSample.cs (not more than necessary)
        // (an alternative is OnTextChanged(0, lines.Count - 1) which invokes TextChanged but there may be side effects)

        if (CurrentTB.WordWrap)
        {
            OnRecalcWordWrap(new TextChangedEventArgs(0, lines.Count - 1));
        }

        CurrentTB.Invalidate();
    }
}

Add this virtual method to the TextSource class:

/// <summary>
/// Called when CurrentTB has initialized this text source.
/// </summary>
public virtual void Initialized()
{
}

In the FCTB class, add this line to the InitTextSource method:

while (LineInfos.Count < ts.Count)
    LineInfos.Add(new LineInfo(-1));

ts.Initialized(); // Add this line

Change the Char constructor for convenience:

public Char(char c, StyleIndex s = StyleIndex.None)
{
    this.c = c;
    style = s;
}

Use as follows:

var b = new TextBuilder(fctb);
b.Styles[0] = new MarkerStyle(Brushes.LightBlue);
b.Append("text", StyleIndex.Style0);
fctb.TextSource = b;

If you want to do it without recompiling FCTB you can just create the TextBuilder class minus virtual method etc. and call b.OnTextChanged(0, b.Count - 1) after assigning TextSource.

FastColoredTextBox: How add large text - similar to StringBuilder but using styles - and without building undo history

1 Answers1