Serilog.Sinks.RichTextBox.WinForms.Colored 1.1.2

.NET 6.0

Requires NuGet 3.3 or higher.

dotnet add package Serilog.Sinks.RichTextBox.WinForms.Colored --version 1.1.2
NuGet\Install-Package Serilog.Sinks.RichTextBox.WinForms.Colored -Version 1.1.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Serilog.Sinks.RichTextBox.WinForms.Colored" Version="1.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Serilog.Sinks.RichTextBox.WinForms.Colored --version 1.1.2
#r "nuget: Serilog.Sinks.RichTextBox.WinForms.Colored, 1.1.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Serilog.Sinks.RichTextBox.WinForms.Colored as a Cake Addin
#addin nuget:?package=Serilog.Sinks.RichTextBox.WinForms.Colored&version=1.1.2

// Install Serilog.Sinks.RichTextBox.WinForms.Colored as a Cake Tool
#tool nuget:?package=Serilog.Sinks.RichTextBox.WinForms.Colored&version=1.1.2


NuGet Downloads Latest version License

A Serilog sink that writes log events to any WinForms RichTextBox control with coloring and custom theme support.

This sink is based on the WPF RichTextBox Sink by C. Augusto Proiete.

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

Getting started

Install the Serilog.Sinks.RichTextBox.WinForms.Colored package from NuGet:

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

Declare your RichTextBox control and give it a name that you can reference it from the code-behind. e.g.:

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";

Then enable the sink using WriteTo.RichTextBox():

Log.Logger = new LoggerConfiguration()

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

Log events will be written to the RichTextBox control:

[11:54:36 INF] Hello, world!


Themes can be specified when configuring the sink:

    .WriteTo.RichTextBox(richTextBox1, theme: ThemePresets.Dark)

The following built-in themes are available at this time:

Theme Description
ThemePresets.Dark Styled to replicate the default theme of Serilog.Sinks.Console; This is the default when no theme is specified
ThemePresets.Light A theme with a light background and contrasting colors.

Output templates

The format of events to the RichTextBox can be modified using the outputTemplate configuration parameter:

        outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}")

The default template, shown in the example above, uses built-in properties like Timestamp and Level. Properties from events, including those attached using enrichers, can also appear in the output template.

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

Product Versions
.NET net6.0-windows net6.0-windows7.0 net7.0-windows net7.0-windows7.0
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • net6.0-windows7.0

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.2 516 10/16/2022
1.1.1 307 9/9/2022
1.1.0 515 6/24/2022
1.0.2 299 6/11/2022
1.0.1 324 5/16/2022
1.0.0 296 5/9/2022

Added cancellation support for message processing thread.
Added exception handling for dispose exceptions.
Small refactors applied to value formatters.
Small refactors applied to token renderers.