Lyo.Pdf
2.0.0
dotnet add package Lyo.Pdf --version 2.0.0
NuGet\Install-Package Lyo.Pdf -Version 2.0.0
<PackageReference Include="Lyo.Pdf" Version="2.0.0" />
<PackageVersion Include="Lyo.Pdf" Version="2.0.0" />
<PackageReference Include="Lyo.Pdf" />
paket add Lyo.Pdf --version 2.0.0
#r "nuget: Lyo.Pdf, 2.0.0"
#:package Lyo.Pdf@2.0.0
#addin nuget:?package=Lyo.Pdf&version=2.0.0
#tool nuget:?package=Lyo.Pdf&version=2.0.0
Lyo.Pdf
Read with PdfPig and edit with PDFsharp for Lyo.Pdf.Models. Start at PdfService. It hands back disposable IPdfReader instances for read/extract work and IPdfWriter instances for structural edits and merges.
Multi-targets netstandard2.0;net10.0.
Examples
Open a document
await using var pdf = await pdfService.OpenFromFileAsync("invoice.pdf", ct);
var info = pdf.GetInfo();
(var width, var height) = pdf.GetPageSizePoints(1);
Edit and merge
using var writer = pdfService.OpenForEdit(bytes);
writer.ImportPagesFrom(otherReader);
writer.InsertBlankPage(writer.PageCount);
writer.ReorderPages([2, 0, 1]);
await writer.SaveAsync("out.pdf", ct);
Add PdfService in 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);
How documents are opened
IPdfService has 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). If you skip that, 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 is the 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, plus 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 that section is missing. - Tables.
ExtractTable(headers, …)yieldsIReadOnlyList<IReadOnlyDictionary<string, string?>>.ExtractDataTable(headers, …)yields 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, …)rely onPdfInferFormattingFlags(Bold, Semicolon, Underline) and optional punctuation terminators. - Sections.
GetSection,GetWordsBetweenSections,GetLinesBetweenSections(plus async).
Edit and merge (IPdfWriter)
MergePdfs/MergePdfsAsync. Merged bytes come back.MergePdfsToFile/MergePdfsToFileAsync. Write the merged bytes to a path.MergePdfsToStream/MergePdfsToStreamAsync. Write the merged bytes to a stream.MergePdfFiles/MergePdfBytes(+ async). File-path or byte-array variants; you designate the initial PDF.
DI registration
PdfServiceOptions is a singleton. PdfService and IPdfService share one scoped instance. If IHttpClientFactory is present, the default registrations create a named client (nameof(PdfService)) for URL loads. Otherwise a new HttpClient is created per call. IMetrics is optional. When it is registered and EnableMetrics = true, PDF operations emit metrics through that implementation.
Dependencies
Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).
Lyo.Common.Metadata(direct, lyo)Lyo.Configuration(direct, lyo)Lyo.Exceptions(direct, lyo)Lyo.Metrics(direct, lyo)Lyo.Pdf.Models(direct, lyo)Lyo.Result(direct, lyo)Microsoft.Extensions.Http10.0.5(direct, microsoft)PDFsharp6.2.4(direct, third-party)PdfPig0.1.15(direct, third-party)Lyo.Common.Core(transitive, lyo)Lyo.DataTable.Models(transitive, lyo)Microsoft.Bcl.AsyncInterfaces10.0.5(transitive, microsoft, netstandard2.0)Microsoft.Extensions.Configuration.Binder10.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.Metadata (>= 2.0.0)
- Lyo.Configuration (>= 2.0.0)
- Lyo.Exceptions (>= 2.0.0)
- Lyo.Metrics (>= 2.0.0)
- Lyo.Pdf.Models (>= 2.0.0)
- Lyo.Result (>= 2.0.0)
- Microsoft.Extensions.Http (>= 10.0.5)
- PdfPig (>= 0.1.15)
- PDFsharp (>= 6.2.4)
-
net10.0
- Lyo.Common.Metadata (>= 2.0.0)
- Lyo.Configuration (>= 2.0.0)
- Lyo.Exceptions (>= 2.0.0)
- Lyo.Metrics (>= 2.0.0)
- Lyo.Pdf.Models (>= 2.0.0)
- Lyo.Result (>= 2.0.0)
- 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.