BlueCrafts.BluePrint.Render 1.1.61

BlueCrafts.BluePrint.Render

Report engine for the BluePrint report platform. Loads a .bpt report definition, runs the layout engine and the expression evaluator, and writes the result to PDF, Excel, HTML or a printer.

This package contains the report model (BluePrint.Core), the expression contract (BluePrint.Expression), the engine itself (BluePrint.Render) and the data source layer (BluePrint.DataSources) that runs a report's query.

Installation

.NET CLI:

dotnet add package BlueCrafts.BluePrint.Render

Package Manager Console in Visual Studio:

Install-Package BlueCrafts.BluePrint.Render

Or add the reference to the project file and restore:

<PackageReference Include="BlueCrafts.BluePrint.Render" Version="1.0.46" />

1.0.46 is only an example. Use the version shown at the top of this page.

Target framework: net10.0.

Those three clients are maintained by the NuGet team. The Paket and Cake tabs on the nuget.org page are third party clients, and the support notice printed under them refers to those clients, not to this package.

Quick start

using BluePrint.Render;

var report = BluePrintDocument.Load("Invoice.bpt");
report.OverrideConnection("MainDB", connectionString);
report.ExportToPdf("Invoice.pdf");

To render into a stream instead of a file, for example from a web service:

report.ExportToPdf(responseStream, provider, measurer: shared, ct: ct);

Data access

BluePrint.DataSources runs the query a report definition carries, including the portable {bp:...} calls that let one report run on SQL Server, PostgreSQL, Firebird, SQLite, Oracle and MySQL alike.

It ships no ADO.NET driver. The host application registers the one it wants, so BluePrint stays free of any database dependency and of the license terms that come with those drivers:

using BluePrint.DataSources;
using Microsoft.Data.Sqlite;   // the driver the host chose, referenced by the host

BpDataProviders.Register(DatabaseProviderType.SQLite, SqliteFactory.Instance);

var profile = new ConnectionProfile
{
    ProviderType = DatabaseProviderType.SQLite,
    DataSource   = "northwind.db",
};

var rows = await new ReportQueryService()
    .ExecuteAsync(profile, report.Definition.DataSource!, argumentValues);

report.SetExternalData(rows);

A host that already has its own data access can skip all of this and hand the rows over directly with SetExternalData.

Output formats

Related packages

Text rendering

Text measurement and line breaking use ICU. On Linux install libicu and set DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=false; on Alpine use icu-libs together with icu-data-full, because icu-data-en omits the Thai dictionary.

License

Free to use, including commercially. Only enterprises with annual revenue above USD 10 million need a commercial license for production use. See LICENSE.txt in this package, or write to craftman@bluecrafts.co.