Pysar.Xaml
0.1.38
See the version list below for details.
dotnet add package Pysar.Xaml --version 0.1.38
NuGet\Install-Package Pysar.Xaml -Version 0.1.38
<PackageReference Include="Pysar.Xaml" Version="0.1.38" />
<PackageVersion Include="Pysar.Xaml" Version="0.1.38" />
<PackageReference Include="Pysar.Xaml" />
paket add Pysar.Xaml --version 0.1.38
#r "nuget: Pysar.Xaml, 0.1.38"
#:package Pysar.Xaml@0.1.38
#addin nuget:?package=Pysar.Xaml&version=0.1.38
#tool nuget:?package=Pysar.Xaml&version=0.1.38
Pysar.Xaml
Declarative report markup for Pysar, a cross-platform report
engine for .NET: this package contains the runtime .rxaml loader and the code-behind source
generator. It depends on the core Pysar package, which carries the element tree, data binding and
the SkiaSharp rendering and PDF engine.
.rxaml is Pysar's markup dialect: an XML document that describes a report the same way the fluent
builder does, using the same elements (Grid, StackPanel, Frame, Text, Image, Repeater)
and the same bands. It is the better fit for a report with a fixed shape — an invoice, a statement, a
certificate — because the layout stays readable as a tree instead of a chain of method calls, and it
is what makes a report editable by someone who is not writing C#: a template stored in a database, or
edited through the design-time preview in Rider and VS Code.
<Report xmlns="https://mriyalab.com/pysar" x:DataType="local:Invoice">
<PageFormat Size="A4" Margin="30" />
<ReportHeaderBand>
<Text Content="{Binding Company.Name}" FontSize="18" FontStyle="Bold" />
</ReportHeaderBand>
<DetailBand DataSource="{Binding Items}">
<DetailBand.DetailHeader>
<Text Content="Product" FontStyle="Bold" />
</DetailBand.DetailHeader>
<Grid ColumnDefinitions="*, 80, 80">
<Text Grid.Column="0" Content="{Binding Product}" />
<Text Grid.Column="1" Content="{Binding Quantity}" />
<Text Grid.Column="2" Content="{Binding Total, StringFormat='{0:C}'}">
<Text.Triggers>
<DataTrigger Binding="{Binding Total}" CompareType="GreaterThan" Value="1000">
<Setter Member="FontColor" Value="Chocolate" />
</DataTrigger>
</Text.Triggers>
</Text>
</Grid>
</DetailBand>
</Report>
An .rxaml report supports the same binding system as the object model: {Binding Path} against the
element's data context, string formats, value converters, and DataTrigger for conditional
formatting. A DataSource on DetailBand (or any Repeater) puts its children in a per-item scope
over the bound collection, with an optional DetailHeader and DetailFooter that stay in the outer
scope.
Loading at runtime
Reports can be loaded at runtime, which is what a template stored in a database or edited by a user needs:
using Pysar.Xaml;
var report = ReportXaml.Load("""
<Report xmlns="https://mriyalab.com/pysar">
<PageFormat Size="A4" Margin="30" />
<DetailBand>
<Text Content="Hello from XAML" />
</DetailBand>
</Report>
""");
report.Build();
Code-behind source generator
For application projects, the source generator uses the standard x:Class directive to provide
generated InitializeComponent(), strongly typed x:Name fields, and compiled object construction.
The generator ships inside this package as an analyzer and is wired up automatically through
build/Pysar.Xaml.props — no separate analyzer reference is needed. Every .rxaml file in the
project is picked up automatically; set <EnableDefaultReportItems>false</EnableDefaultReportItems>
to list them yourself. Resources, styles, and triggers currently use the runtime-loader fallback.
Compile-time binding validation
Any element accepts the MAUI-style directive x:DataType="local:Invoice" to declare the
data-context type of a scope. The hint is design-time only — it is ignored when the report is
loaded — and is inherited by child elements until another element declares its own;
x:DataType="" clears it for that subtree. The source generator validates {Binding ...} paths —
and DataTrigger.Binding — against the hint at build time (PQX010 error for an unknown member,
PQX011 warning for a type it cannot resolve). Where the scope cannot be known, nothing is reported
rather than guessed: styles and resource dictionaries are reused across scopes, so their bindings are
never validated. The XAML designer idiom d:DataContext="{d:DesignInstance Type=local:Invoice}" is
an accepted alternative spelling of the same hint, used when no x:DataType is present on the
element.
Documentation
License
MIT — see LICENSE.
| Product | Versions 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. |
-
net10.0
- HarfBuzzSharp (>= 14.2.1.1)
- HarfBuzzSharp.NativeAssets.Linux (>= 14.2.1.1)
- HarfBuzzSharp.NativeAssets.macOS (>= 14.2.1.1)
- HarfBuzzSharp.NativeAssets.Win32 (>= 14.2.1.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.11)
- Pysar (>= 0.1.38)
- SkiaSharp (>= 4.151.2)
- SkiaSharp.NativeAssets.Linux (>= 4.151.2)
- SkiaSharp.NativeAssets.macOS (>= 4.151.2)
- SkiaSharp.NativeAssets.Win32 (>= 4.151.2)
- Svg.Skia (>= 5.2.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
### Added
- `Pysar.Uno`: a new platform package for [Uno Platform](https://platform.uno/). One `net10.0` target covers every Uno Skia host - Desktop, WebAssembly, Android and iOS - and it brings the same `ReportView` the other platform packages do: a scrollable, zoomable viewer that rasterises only the visible region, so memory follows the viewport rather than the zoom level. Built against Uno 6.7.
- `PysarUno.Use(assembly, configure)` / `PysarUno.UseAsync(...)` (`Pysar.Uno`): registration for an Uno application, called from `OnLaunched`. A static entry point rather than a service registration, because an Uno application has no service collection of its own unless it also uses Uno.Extensions. Returns the handler, and exposes the shared `PysarUno.Renderer` and `PysarUno.ExportService`.
- `UnoReportPlatformHandler` and `UnoAssetFileSystem` (`Pysar.Uno`): report assets are read from embedded resources whose `LogicalName` is the path the report asks for. Embedded rather than `ms-appx:///` because font registration, `ResourceDictionary` sources and image loading all read synchronously, and blocking on Uno's asynchronous `StorageFile` deadlocks the single-threaded WebAssembly host. `UnoAssetFileSystem.PreloadAsync` fetches `Content`-packaged assets once at startup for applications that would rather keep them that way.
- `UnoReportPrinter` (`Pysar.Uno`): desktop printing through the same vector PDF pipeline as export - the macOS Print panel via PDFKit, the shell print verb on Windows, the default viewer on Linux. Android, iOS and WebAssembly throw `PlatformNotSupportedException`; produce the bytes through `PysarUno.ExportService` and share or download them from the application.
- `MacPinchMonitor` and `MacMagnifyEventArgs` (`Pysar.Core.Platform`, in `Pysar`): an AppKit local event monitor for `NSEventTypeMagnify`, now public and shared by every host that needs it. No user-interface framework tested surfaces a trackpad pinch as a gesture on macOS - it arrives as plain wheel deltas indistinguishable from a two-finger scroll - so a trackpad zoom has to come from AppKit directly. `Start`/`Stop` are no-ops on every other platform.
### Changed
- `MacPinchMonitor` moved from `Pysar.Avalonia`, where it was internal, into `Pysar`. Behaviour is unchanged for Avalonia applications; the type is simply no longer duplicated per host. It is plain P/Invoke against libobjc with no dependency on any user-interface framework, which is why it belongs beside `MacOsPdfPrint` in the core package.
- HarfBuzzSharp moves from 14.2.0 to 14.2.1.1 across every package, managed wrapper and native assets together. Required by Uno, and applied as a family because a split between the managed wrapper and its native assets is a startup crash rather than a build error.
- Docs: the quick start and README now cover Uno alongside the other platforms, including the two places it deviates - registration is `PysarUno.Use` rather than `UsePysar`/`AddPysar`, and assets are embedded resources rather than package URIs.
### Notes
- `Pysar.Uno 0.1.35-preview`, published earlier to the internal feed, is superseded and should not be used. It required an `Uno.WinUI` prerelease that no released `Uno.Sdk` provides, so no standard Uno application could consume it. This release targets stable Uno 6.7 instead and ships as an ordinary stable package.
- The Uno report view has been exercised on macOS Desktop - loading, pagination, zoom modes, and trackpad pinch. Its other hosts (WebAssembly, Android, iOS) build from the same single target but have not yet been run.