Mavusi.PdfSharpCore 2.0.0

PdfSharpCore (forked)

PdfSharpCore (forked by Mavusi) is a partial port of PdfSharp.Xamarin for .NET Standard. Additionally MigraDoc has been ported as well (from version 1.32). Native image support has been implemented for JPEG, PNG, and BMP formats without external dependencies. Font support provided by SixLabors.Fonts.

Original project by ststeiger → https://github.com/ststeiger/PdfSharpCore.

This fork added:

• Native image processing (JPEG, PNG, BMP) - no ImageSharp dependency required
• Lesser "accuracy level" (Pdf.IO.enums.PdfReadAccuracy.Lazy) for opening some broken PDFs
• Preliminary support for PDF Signatures validation (PdfDocument.IsSigned, PdfDocument.Signatures)

Table of Contents

• Documentation
• Example
• Contributing
• License

Example

The following code snippet creates a simple PDF-file with the text 'Hello World!'. The code is written for a .NET 6 console app with top level statements.

using PdfSharpCore.Drawing;
using PdfSharpCore.Fonts;
using PdfSharpCore.Pdf;
using PdfSharpCore.Utils;

GlobalFontSettings.FontResolver = new FontResolver();

var document = new PdfDocument();
var page = document.AddPage();

var gfx = XGraphics.FromPdfPage(page);
var font = new XFont("Arial", 20, XFontStyle.Bold);

var textColor = XBrushes.Black;
var layout = new XRect(20, 20, page.Width, page.Height);
var format = XStringFormats.Center;

gfx.DrawString("Hello World!", font, textColor, layout, format);

document.Save("helloworld.pdf");

Publishing to NuGet

This package supports .NET 8, .NET 9, and .NET 10 through multi-targeting.

Before Publishing

1. Update Version Numbers

   Before publishing a new version, update the version in all project files:

   • PdfSharpCore/Moondigo.PdfSharpCore.csproj
   • PdfSharpCore.Charting/PdfSharpCore.Charting.csproj
   • MigraDocCore.DocumentObjectModel/MigraDocCore.DocumentObjectModel.csproj
   • MigraDocCore.Rendering/MigraDocCore.Rendering.csproj

   Update the following properties:

   <Version>1.0.1</Version>
   <AssemblyVersion>1.0.1.0</AssemblyVersion>
   <FileVersion>1.0.1.0</FileVersion>
   

   Note: Follow Semantic Versioning:

   • MAJOR version for incompatible API changes
   • MINOR version for new functionality in a backward compatible manner
   • PATCH version for backward compatible bug fixes

2. Update Release Notes (optional but recommended)

   Update the <PackageReleaseNotes> property in each project file to describe what's new in this version.

Publishing Steps

1. Clean and Build in Release Mode

   dotnet clean
   dotnet build -c Release
   

2. Create NuGet Packages

   Packages are automatically created during build (when GeneratePackageOnBuild is True). Find them in:

   • PdfSharpCore/bin/Release/
   • PdfSharpCore.Charting/bin/Release/
   • MigraDocCore.DocumentObjectModel/bin/Release/
   • MigraDocCore.Rendering/bin/Release/

   Alternatively, manually pack:

   dotnet pack -c Release
   

3. Publish to NuGet

   Quick Publish (One Command)

   Copy and paste this command to build and publish all packages at once:

   $apiKey = "YOUR_API_KEY_HERE"; dotnet clean; dotnet build -c Release; Get-ChildItem -Path . -Recurse -Filter "*.nupkg" | Where-Object { $_.FullName -like "*\bin\Release\*" } | ForEach-Object { dotnet nuget push $_.FullName --source https://api.nuget.org/v3/index.json --api-key $apiKey --skip-duplicate }
   

   Or publish using wildcards:

   # Navigate to each project's Release folder or use wildcards
   dotnet nuget push "**/*.nupkg" --source https://api.nuget.org/v3/index.json --api-key YOUR_API_KEY_HERE --skip-duplicate
   

   Or publish each package individually:

   dotnet nuget push PdfSharpCore/bin/Release/Mavusi.PdfSharpCore.1.0.1.nupkg -s https://api.nuget.org/v3/index.json -k YOUR_API_KEY_HERE
   

   Note: Get your NuGet API key from https://www.nuget.org/account/apikeys

4. Verify Publication

   After publishing, verify your package appears at:

   • https://www.nuget.org/packages/Mavusi.PdfSharpCore/

Multi-Targeting Support

The NuGet package includes binaries for:

• net8.0
• net9.0
• net10.0

NuGet will automatically select the appropriate target framework based on the consuming project's target framework.

Contributing

We appreciate feedback and contribution to this repo!

License

This software is released under the MIT License. See the LICENSE file for more info.

PdfSharpCore relies on the following projects:

• SixLabors.Fonts (Apache 2.0 license when distributed as part of PdfSharpCore)
  • See https://github.com/SixLabors/Fonts/blob/master/LICENSE for details