Lyo.Pdf
1.0.4
dotnet add package Lyo.Pdf --version 1.0.4
NuGet\Install-Package Lyo.Pdf -Version 1.0.4
<PackageReference Include="Lyo.Pdf" Version="1.0.4" />
<PackageVersion Include="Lyo.Pdf" Version="1.0.4" />
<PackageReference Include="Lyo.Pdf" />
paket add Lyo.Pdf --version 1.0.4
#r "nuget: Lyo.Pdf, 1.0.4"
#:package Lyo.Pdf@1.0.4
#addin nuget:?package=Lyo.Pdf&version=1.0.4
#tool nuget:?package=Lyo.Pdf&version=1.0.4
Lyo.Pdf
PdfPig-backed reading and PDFsharp-backed editing for Lyo.Pdf.Models. PdfService is the entry point; it returns disposable IPdfReader instances for read/extract workflows and IPdfWriter instances for structural edits and merges.
Multi-targets netstandard2.0;net10.0.
Examples
Open a PDF
await using var pdf = await pdfService.OpenFromFileAsync("invoice.pdf", ct);
var info = pdf.GetInfo();
(var width, var height) = pdf.GetPageSizePoints(1);
Edit and merge PDFs
using var writer = pdfService.OpenForEdit(bytes);
writer.ImportPagesFrom(otherReader);
writer.InsertBlankPage(writer.PageCount);
writer.ReorderPages([2, 0, 1]);
await writer.SaveAsync("out.pdf", ct);
Register with DI
services.AddPdfService();
services.AddPdfService(options => options.DefaultYTolerance = 4.0);
services.AddPdfServiceFromConfiguration(configuration); // section "PdfServiceOptions"
services.AddPdfService(sp => sp.GetRequiredService<IHttpClientFactory>().CreateClient("pdf"));
services.AddPdfService(httpClientName: "pdf");
services.AddPdfServiceKeyed("primary", configure: o => o.EnableMetrics = true);
Loading
IPdfService exposes paired sync and async loaders for file, bytes, and
stream (OpenFromFile, OpenFromFileAsync, OpenFromBytes,
OpenFromBytesAsync, OpenFromStream, OpenFromStreamAsync) plus matching batch
overloads (OpenFromFiles, OpenFromFilesAsync, OpenFromBytesBatch,
OpenFromBytesBatchAsync, OpenFromStreams, OpenFromStreamsAsync).
URL loaders are async only — OpenFromUrlAsync and OpenFromUrlsAsync — so the
service never blocks on synchronous HTTP. Register an HttpClient via DI to share
connection pooling and timeouts (see below); without one, a new HttpClient is
created per call and disposed.
Each loader returns an IPdfReader (PdfPig + immutable byte snapshot).
The caller owns the instance and must dispose it (using /
await using); PdfService itself does not implement IDisposable.
PdfServiceOptions.MaxPdfSizeBytes enforces a per-PDF byte cap (default
SuggestedMaxPdfSizeBytes = 25 MiB).
Extraction (pdf.Text)
- Words and lines —
GetWords/GetLines(+ async) with optional page and line tolerance. - Anchored slices —
GetWordsBetween/GetLinesBetween(+ async). - Regions —
GetLinesInBoundingBox,GetColumnarTextInBoundingBox, and a word-list overloadGetColumnarText(words, columnCount, yTolerance?). - Key/value pairs —
ExtractKeyValuePairswithint? page,PdfWord[],PdfSection, and section-name overloads (startSection+ orderedsectionsInOrder+ optionaldefaultEndSection, page range, andyTolerance). Section-name overloads returnnullwhen the requested section is not found. - Tables —
ExtractTable(headers, …)returnsIReadOnlyList<IReadOnlyDictionary<string, string?>>.ExtractDataTable(headers, …)returns aLyo.DataTable. Section-name overloads returnnullwhen the section is missing.ParseBytesAsDataTablere-opens a byte buffer for one-shot extraction. - Inference helpers —
InferKeyValuePairsFromFormatting(words, yTolerance, columnCount, inferFlags, keyValueDelimiters?)andInferTableHeadersFromFormatting(words, …)usePdfInferFormattingFlags(Bold, Semicolon, Underline) and optional punctuation terminators. - Sections —
GetSection,GetWordsBetweenSections,GetLinesBetweenSections(+ async).
Editing and merging (IPdfWriter)
MergePdfs/MergePdfsAsync— return merged bytes.MergePdfsToFile/MergePdfsToFileAsync— write merged bytes to a path.MergePdfsToStream/MergePdfsToStreamAsync— write merged bytes to a stream.MergePdfFiles/MergePdfBytes(+ async) — file-path or byte-array variants with a designated initial PDF.
Dependency injection
PdfServiceOptions is registered as a singleton; PdfService and IPdfService share the same scoped instance. When an IHttpClientFactory is available the default registrations create a named client (nameof(PdfService)) for URL loads; otherwise HttpClient is created per-call. IMetrics is optional — when present and EnableMetrics = true, PDF operations emit metrics through the registered implementation.
Dependencies
Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).
Lyo.Common— (direct, lyo)Lyo.Exceptions— (direct, lyo)Lyo.Metrics— (direct, lyo)Lyo.Pdf.Models— (direct, lyo)Lyo.Result— (direct, lyo)Microsoft.Extensions.Configuration.Binder10.0.5— (direct, microsoft)Microsoft.Extensions.Http10.0.5— (direct, microsoft)PDFsharp6.2.4— (direct, third-party)PdfPig0.1.15— (direct, third-party)Lyo.DataTable.Models— (transitive, lyo)Microsoft.Extensions.DependencyInjection.Abstractions10.0.5— (transitive, microsoft)Microsoft.Extensions.Logging.Abstractions10.0.5— (transitive, microsoft)Microsoft.Extensions.Options.ConfigurationExtensions10.0.5— (transitive, microsoft)System.Memory4.6.3— (transitive, microsoft, netstandard2.0)System.Text.Json10.0.5— (transitive, microsoft, netstandard2.0)
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. 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. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Lyo.Common (>= 1.0.4)
- Lyo.Exceptions (>= 1.0.4)
- Lyo.Metrics (>= 1.0.4)
- Lyo.Pdf.Models (>= 1.0.4)
- Lyo.Result (>= 1.0.4)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.5)
- Microsoft.Extensions.Http (>= 10.0.5)
- PdfPig (>= 0.1.15)
- PDFsharp (>= 6.2.4)
-
net10.0
- Lyo.Common (>= 1.0.4)
- Lyo.Exceptions (>= 1.0.4)
- Lyo.Metrics (>= 1.0.4)
- Lyo.Pdf.Models (>= 1.0.4)
- Lyo.Result (>= 1.0.4)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.5)
- Microsoft.Extensions.Http (>= 10.0.5)
- PdfPig (>= 0.1.15)
- PDFsharp (>= 6.2.4)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Lyo.Pdf:
| Package | Downloads |
|---|---|
|
Lyo.Pdf.Web.Components
Reusable Blazor components for PDF workbenches, annotation helpers, and HTML to PDF workflows. |
GitHub repositories
This package is not used by any popular GitHub repositories.