Skip to content

vonhoff/Serilog.Sinks.RichTextBox.WinForms.Colored

Repository files navigation

Serilog.Sinks.RichTextBox.WinForms.Colored

NuGet Downloads workflow Latest version License

A Serilog sink that writes log events to a WinForms RichTextBox with support for coloring and custom themes.

Screenshot of Serilog.Sinks.RichTextBox.WinForms.Colored in action

Features

  • Colored log events in a WinForms RichTextBox control
  • Multiple theme presets with customization options
  • High-performance asynchronous processing
  • Line limit to control memory usage
  • WCAG compliant color schemes based on the Serilog WPF RichTextBox sink.

Get Started

Install the package from NuGet:

Install-Package Serilog.Sinks.RichTextBox.WinForms.Colored

Declare your RichTextBox control:

private System.Windows.Forms.RichTextBox richTextBox1;

private void InitializeComponent()
{
    this.richTextBox1.BackColor = System.Drawing.SystemColors.Window;
    this.richTextBox1.Dock = System.Windows.Forms.DockStyle.Fill;
    this.richTextBox1.Font = new System.Drawing.Font("Cascadia Mono", 10.8F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point);
    this.richTextBox1.Location = new System.Drawing.Point(0, 0);
    this.richTextBox1.Name = "richTextBox1";
}

Configure the logger to use the sink using the RichTextBox extension method:

Log.Logger = new LoggerConfiguration()
    .WriteTo.RichTextBox(richTextBox1, theme: ThemePresets.Literate)
    .CreateLogger();

Log.Information("Hello, world!");

See the Extension Method for more configuration options.

Themes

Available built-in themes:

Theme Description
ThemePresets.Literate Styled to replicate the default theme of Serilog.Sinks.Console (default)
ThemePresets.Grayscale A theme using only shades of gray, white, and black
ThemePresets.Colored A theme based on the original Serilog.Sinks.ColoredConsole sink
ThemePresets.Luminous A light theme with high contrast for accessibility

The themes based on the original sinks are slightly adjusted to be WCAG compliant, ensuring that the contrast ratio between text and background colors is at least 4.5:1.

You can create your own custom themes by creating a new instance of the Theme class and passing it to the RichTextBox extension method. Look at the existing themes for examples.

Frequently Asked Questions

Why is the package name so long?

Shorter alternatives were already reserved in the NuGet registry, so a more descriptive name was needed for this implementation. The name is a bit long, but it makes it easier to find the package in the NuGet registry.

Why use a WinForms RichTextBox instead of a WPF RichTextBox?

This sink is specifically designed for WinForms applications to avoid the WPF framework. Using a WPF-based logging component would require adding the entire WPF framework with all its dependencies, greatly increasing the size of the application.

Support and Contribute

If you find value in this project, there are several ways you can contribute:

  • Give the project a star on GitHub ⭐
  • Support the project through GitHub Sponsors
  • Improve documentation, report bugs, or submit pull requests

License

Copyright © 2025 Simon Vonhoff & Contributors - Provided under the Apache License, Version 2.0.