Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vonhoff/serilog.sinks.richtextbox.winforms.colored
A Serilog sink that writes log events to a WinForms RichTextBox control with colors and theme support.
https://github.com/vonhoff/serilog.sinks.richtextbox.winforms.colored
colored colored-log colored-logging console forms logger logging rich-text richtextbox serilog serilog-sink sink sinks themes windows-forms winforms
Last synced: 3 months ago
JSON representation
A Serilog sink that writes log events to a WinForms RichTextBox control with colors and theme support.
- Host: GitHub
- URL: https://github.com/vonhoff/serilog.sinks.richtextbox.winforms.colored
- Owner: vonhoff
- License: apache-2.0
- Created: 2022-05-09T12:44:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-28T08:27:50.000Z (4 months ago)
- Last Synced: 2024-10-08T13:26:37.089Z (4 months ago)
- Topics: colored, colored-log, colored-logging, console, forms, logger, logging, rich-text, richtextbox, serilog, serilog-sink, sink, sinks, themes, windows-forms, winforms
- Language: C#
- Homepage:
- Size: 133 KB
- Stars: 16
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serilog.Sinks.RichTextBox.WinForms.Colored
[](https://www.nuget.org/packages/Serilog.Sinks.RichTextBox.WinForms.Colored)
[](https://www.nuget.org/packages/Serilog.Sinks.RichTextBox.WinForms.Colored)
[](https://opensource.org/licenses/Apache-2.0)
A [Serilog](https://github.com/serilog/serilog) sink that writes log events to
a [WinForms RichTextBox](https://docs.microsoft.com/en-us/dotnet/desktop/winforms/controls/richtextbox-control-overview-windows-forms)
with support for coloring and custom themes.
## Features
- Write log events to a WinForms RichTextBox control
- Customizable themes (Dark and Light presets available)
- Configurable output templates
- Auto-scrolling option
- Line limit control
## Installation
Install the package from NuGet:
```powershell
Install-Package Serilog.Sinks.RichTextBox.WinForms.Colored
```
## Usage
### Basic Setup
Declare your RichTextBox control:
```csharp
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:
```csharp
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:
```csharp
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:
| Theme | Description |
|----------------------|---------------------------------------------------------|
| `ThemePresets.Dark` | Similar to the default theme of _Serilog.Sinks.Console_ |
| `ThemePresets.Light` | Light background with contrasting colors |
## Support and Contribute
If you find value in this project, there are several ways you can contribute:
- **Become a Sponsor:** Support the project through [GitHub Sponsors](https://github.com/sponsors/vonhoff).
- **Show Your Appreciation:** Give the [project](https://github.com/vonhoff/Serilog.Sinks.RichTextBox.WinForms.Colored) a star on GitHub.
- **Contribute:** Improve documentation, report bugs, or submit pull requests.
## License
This project is licensed under the [Apache License, Version 2.0](LICENSE).