Serilog.Sinks.RichTextBox.WinForms.Colored 2.1.0

Serilog.Sinks.RichTextBox.WinForms.Colored

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

Features

• Colorful, formatted log events in a WinForms RichTextBox control
• Dark and Light theme presets with customization options
• Configurable output templates
• Auto-scrolling to latest messages
• Line limiting to control memory usage

Installation

Install the package from NuGet:

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

Usage

Basic Setup

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("Consolas", 10.8F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point);
    this.richTextBox1.Location = new System.Drawing.Point(0, 0);
    this.richTextBox1.Name = "richTextBox1";
}

Configure the logger:

Log.Logger = new LoggerConfiguration()
    .WriteTo.RichTextBox(richTextBox1)
    .CreateLogger();

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

Advanced Configuration

You can customize the sink using various parameters from the RichTextBox extension method:

Log.Logger = new LoggerConfiguration()
    .WriteTo.RichTextBox(
        richTextBoxControl: richTextBox1,
        minimumLogEventLevel: LogEventLevel.Debug,
        outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}",
        theme: ThemePresets.Light,
        messageBatchSize: 100,
        messagePendingInterval: 10,
        autoScroll: true,
        maxLogLines: 1000)
    .CreateLogger();

Themes

Available built-in themes:

Frequently Asked Questions

Why is the package name so long?

The long name Serilog.Sinks.RichTextBox.WinForms.Colored follows the Serilog naming convention while being specific about the functionality. Shorter alternatives were already reserved in the NuGet registry but were not used, so a more descriptive name was needed for this implementation.

Why use a WinForms solution instead of the WPF one?

This sink was designed specifically for WinForms applications to avoid unnecessary dependencies. Including a WPF-based logging component in a WinForms application would require including the entire WPF framework as a dependency, significantly increasing the footprint of the application for what should be a small logging feature.

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

This project is licensed under the Apache License, Version 2.0.