PouryaKit.Reporting 0.1.0-preview.2

This is a prerelease version of PouryaKit.Reporting.
dotnet add package PouryaKit.Reporting --version 0.1.0-preview.2
                    
NuGet\Install-Package PouryaKit.Reporting -Version 0.1.0-preview.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="PouryaKit.Reporting" Version="0.1.0-preview.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="PouryaKit.Reporting" Version="0.1.0-preview.2" />
                    
Directory.Packages.props
<PackageReference Include="PouryaKit.Reporting" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add PouryaKit.Reporting --version 0.1.0-preview.2
                    
#r "nuget: PouryaKit.Reporting, 0.1.0-preview.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.
#:package PouryaKit.Reporting@0.1.0-preview.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=PouryaKit.Reporting&version=0.1.0-preview.2&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=PouryaKit.Reporting&version=0.1.0-preview.2&prerelease
                    
Install as a Cake Tool

PouryaKit.Reporting

NuGet .NET 10 License: MIT

PouryaKit.Reporting

A Module's report laid out once and rendered in memory to a PDF, a CSV file or a spreadsheet. A Module builds a ReportLayout from what it read: a title, an introduction, one table of text cells and its branding. IReportRenderer turns it into a file and returns a Result with its bytes, content type and extension.

Install

dotnet add package PouryaKit.Reporting --prerelease

When to use it

  • A Module produces a document for people to download, print or open in a spreadsheet.
  • You brand a report with a logo and an accent colour.
  • You need to know which layouts the renderer refuses.

It stores nothing: store the bytes through PouryaKit.Storage, or let PouryaKit.Reporting.Module run the whole job in the background.

Quick start

Register the renderer in each Module that renders reports (Registering). Then build the layout and render it, as the Kit's tests do:

private static readonly ReportLayout Sales = new(
    "Monthly sales",
    new ReportTable(
        [
            new("Product"),
            new("Quantity", ReportAlignment.Right),
            new("Amount", ReportAlignment.Right),
        ],
        Rows
    )
)
{
    Introduction =
    [
        new ReportHeading("October 2026"),
        new ReportParagraph("Every order the shop settled this month."),
    ],
    PageHeader = "Acme Shop",
    PageFooter = "Confidential",
    Branding = new() { Logo = Logo, Accent = new(0x1F, 0x4E, 0x79) },
};

var report = _renderer.Render(Sales, ReportFormat.Pdf).Value;

What you get

  • One layout for all three formats.
  • The file in memory, as a Result.
  • A logo, an accent colour and an embedded font, in the formats that show them.
  • A layout the renderer cannot honour refused as an Error.

The Module formats every value: every cell is text, so a number, an amount or a date is formatted by the Module, in the culture it chooses. The embedded font holds no Persian or Arabic glyphs, and the PDF lays out no right-to-left text.

Learn more

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on PouryaKit.Reporting:

Package Downloads
PouryaKit.Reporting.Module

The Kit's report Module: report jobs generated in the background, stored through the Host's file storage and served to their requester by a time-limited link.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0-preview.2 70 11/1/2026
0.1.0-preview.1 82 10/31/2026
0.1.0-preview.0.28 69 10/26/2026