Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork27
A Serilog sink that writes log events to a WPF RichTextBox control with colors and theme support
License
serilog-contrib/serilog-sinks-richtextbox
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
| README.md |
|---|
ASerilog sink that writes log events to any WPFRichTextBox control with coloring and custom theme support.
If you like or are using this project please give it a star. Thanks!
Install theSerilog.Sinks.RichTextBox.Wpf package from NuGet:
Install-Package Serilog.Sinks.RichTextBox.Wpf-Prerelease
Declare yourRichTextBox control and give it a name that you can reference it from the code-behind. e.g.:
<Window (...)> <RichTextBoxx:Name="MyRichTextBox"Background="Black"Foreground="LightGray"FontFamily="Cascadia Mono, Consolas, Courier New, monospace"VerticalScrollBarVisibility="Auto" /></Window>
Then enable the sink usingWriteTo.RichTextBox():
Log.Logger=newLoggerConfiguration().WriteTo.RichTextBox(MyRichTextBox).CreateLogger();Log.Information("Hello, world!");
Log events will be written to theRichTextBox control:
[11:54:36 INF] Hello, world!The sink will colorize output by default:
Themes can be specified when configuring the sink:
.WriteTo.RichTextBox(MyRichTextBox,theme:RichTextBoxConsoleTheme.Grayscale)
The following built-in themes are available at this time:
| Theme | Description |
|---|---|
RichTextBoxTheme.None | No styling. Uses default styles applied to theRichTextBox control |
RichTextBoxConsoleTheme.Literate | Styled to replicate the default theme ofSerilog.Sinks.Console;This is the default when no theme is specified |
RichTextBoxConsoleTheme.Grayscale | A theme using only shades of gray, white, and black |
RichTextBoxConsoleTheme.Colored | A theme based on the originalSerilog.Sinks.ColoredConsole sink |
Adding a new theme is straightforward; examples can be found in theRichTextBoxConsoleThemes class.
The format of events to the RichTextBox can be modified using theoutputTemplate configuration parameter:
.WriteTo.RichTextBox(MyRichTextBox,outputTemplate:"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}")
The default template, shown in the example above, uses built-in properties likeTimestamp andLevel. Properties from events, including those attached usingenrichers, can also appear in the output template.
Click on theReleases tab on GitHub.
Copyright © 2021-2023 C. Augusto Proiete & Contributors - Provided under theApache License, Version 2.0.
About
A Serilog sink that writes log events to a WPF RichTextBox control with colors and theme support
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Contributors7
Uh oh!
There was an error while loading.Please reload this page.

