Installation

Requirements

The all-in-one package

X-Ray contains no code. It depends on every member of the family, so one reference brings in all of them:

dotnet add package X-Ray

<PackageReference Include="X-Ray" Version="*" />

Each X-Ray release depends on the newest version of every member that was published when it was built. A member that has not been published yet is not a dependency; the first X-Ray release after it ships adds it.

Individual packages

Install only the members you use:

dotnet add package X-Ray.Content    # content extraction
dotnet add package X-Ray.Office     # Word, Excel, PowerPoint: read and render to PDF/images
dotnet add package X-Ray.Psd        # Photoshop PSD/PSB
dotnet add package X-Ray.Psd.Skia   # optional: SkiaSharp interop for X-Ray.Psd
dotnet add package X-Ray.Psd.Text   # optional: re-render PSD type layers
dotnet add package X-Ray.Email      # MSG, EML, CFB
dotnet add package X-Ray.Ics        # iCalendar and vCalendar: events, recurrence, writing
dotnet add package X-Ray.PS         # PostScript, EPS, XPS
dotnet add package X-Ray.PS.Skia    # optional: SkiaSharp raster output for X-Ray.PS
dotnet add package X-Ray.OneNote    # OneNote .one

Nothing is lost by referencing a member directly. Two reasons to prefer it:

• Your dependency graph holds only what you use. X-Ray.Office, for example, brings SkiaSharp and HarfBuzzSharp for rendering; a service that only extracts text does not need them.
• A new family member cannot arrive in your build without you asking for it.

You can also mix the two: reference X-Ray, and add a direct reference to one member at a newer version than X-Ray pins. NuGet resolves the higher version.

Package ids and namespaces

Package ids are hyphenated; assemblies and namespaces are not, because a hyphen is not valid in a C# identifier:

Native dependencies

The core of every package is managed code. Native code enters only here:

X-Ray.Psd, X-Ray.Email, X-Ray.Ics, X-Ray.PS and X-Ray.OneNote have no dependencies outside the .NET base class library.

Versions

Versions are CalVer: yy.M.<build>, for example 26.9.5114. Every package is published by its own pipeline, so members' versions differ from each other and from X-Ray's. There are no prerelease suffixes; a higher version is a newer build.

Licenses