Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/serilog-contrib/serilog-sinks-richtextbox

A Serilog sink that writes log events to a WPF RichTextBox control with colors and theme support
https://github.com/serilog-contrib/serilog-sinks-richtextbox

augustoproiete console hacktoberfest richtextbox serilog sinks themes wpf

Last synced: 1 day ago
JSON representation

A Serilog sink that writes log events to a WPF RichTextBox control with colors and theme support

Host: GitHub
URL: https://github.com/serilog-contrib/serilog-sinks-richtextbox
Owner: serilog-contrib
License: apache-2.0
Created: 2021-02-10T23:55:44.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-12-18T18:13:18.000Z (13 days ago)
Last Synced: 2024-12-23T00:03:14.795Z (8 days ago)
Topics: augustoproiete, console, hacktoberfest, richtextbox, serilog, sinks, themes, wpf
Language: C#
Homepage:
Size: 214 KB
Stars: 111
Watchers: 5
Forks: 25
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        | README.md |

|:---|







Serilog.Sinks.RichTextBox.Wpf



A [Serilog](https://serilog.net) sink that writes log events to any WPF [RichTextBox](https://docs.microsoft.com/en-us/dotnet/desktop/wpf/controls/richtextbox-overview?view=netframeworkdesktop-4.8) control with coloring and custom theme support.

[![NuGet Version](http://img.shields.io/nuget/v/Serilog.Sinks.RichTextBox.Wpf.svg?style=flat)](https://www.nuget.org/packages/Serilog.Sinks.RichTextBox.Wpf) [![.NET](https://img.shields.io/badge/.NET%20-%3E%3D%205.0-512bd4)](https://dotnet.microsoft.com/download) [![.NET Core](https://img.shields.io/badge/.NET%20Core-%3E%3D%203.1-512bd4)](https://dotnet.microsoft.com/download) [![.NET Framework](https://img.shields.io/badge/.NET%20Framework-%3E%3D%204.6.2-512bd4)](https://dotnet.microsoft.com/download) [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-serilog-orange.svg)](http://stackoverflow.com/questions/tagged/serilog)

![Screenshot of Serilog.Sinks.RichTextBox.Wpf in action](asset/serilog-sinks-richtextbox-screenshot.png)



## Give a Star! :star:

If you like or are using this project please give it a star. Thanks!

## Getting started :rocket:

Install the [Serilog.Sinks.RichTextBox.Wpf](https://www.nuget.org/packages/Serilog.Sinks.RichTextBox.Wpf) package from NuGet:

```powershell

Install-Package Serilog.Sinks.RichTextBox.Wpf -Prerelease

```

Declare your [RichTextBox](https://docs.microsoft.com/en-us/dotnet/desktop/wpf/controls/richtextbox-overview?view=netframeworkdesktop-4.8) control and give it a name that you can reference it from the code-behind. e.g.:

```xml

  

```

Then enable the sink using `WriteTo.RichTextBox()`:

```csharp

Log.Logger = new LoggerConfiguration()

    .WriteTo.RichTextBox(MyRichTextBox)

    .CreateLogger();

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

```

Log events will be written to the `RichTextBox` control:

```

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

```

### Themes

The sink will colorize output by default:

![Screenshot of Serilog.Sinks.RichTextBox.Wpf in action](asset/serilog-sinks-richtextbox-screenshot.png)

Themes can be specified when configuring the sink:

```csharp

    .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 the `RichTextBox` control                                                  |

| `RichTextBoxConsoleTheme.Literate`  | Styled to replicate the default theme of  _Serilog.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 original `Serilog.Sinks.ColoredConsole` sink                                                     |

 Adding a new theme is straightforward; examples can be found in the [`RichTextBoxConsoleThemes`](src/Serilog.Sinks.RichTextBox.Wpf/Sinks/RichTextBox/Themes/RichTextBoxConsoleThemes.cs) class.

### Output templates

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

```csharp

    .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 like `Timestamp` and `Level`. Properties from events, including those attached using [enrichers](https://github.com/serilog/serilog/wiki/Enrichment), can also appear in the output template.

## Release History

Click on the [Releases](https://github.com/serilog-contrib/serilog-sinks-richtextbox/releases) tab on GitHub.

---

_Copyright © 2021-2023 C. Augusto Proiete & Contributors - Provided under the [Apache License, Version 2.0](LICENSE)._