Package Overview

TX Text Control .NET Server consists of several NuGet packages. To pick the right combination before you install anything, find each package described with where to get it, followed by the packages that common project types need.

Package Sources

You get the packages from up to three sources:

• Text Control Private NuGet Feed (https://www.textcontrol.com/nuget/v3/index.json): the licensed packages for customers with an active license. Your license is injected into the package on the server before the download. See Text Control Private NuGet Feed.
• nuget.org: public packages published by the txtextcontrol profile, such as the Blazor components and the Markdown and PDF validation libraries. See Public NuGet Packages.
• Text Control Offline Packages: a local package source that the Windows setup (trial or full version) installs. See Offline Packages.

Packages at a Glance

The private feed also contains packages of other Text Control products, such as TXTextControl.TextControl.WinForms.SDK and TXTextControl.TextControl.WPF.SDK. You only see them if you are licensed for those products.

A "Yes" in the offline source column means that Text Control's tutorials install the package from the local Text Control Offline Packages source. For the packages marked with a dash, this is not documented.

Engine Packages

Every project that creates, loads or saves documents references one of the two engine packages. Both packages contain the ServerTextControl and MailMerge classes, so your code looks the same with either engine. Core runs on Windows and Linux and is recommended for new .NET 8 or higher projects; Classic runs on Windows only and supports DOC. Core and Classic compares the engines.

TXTextControl.TextControl.Core.SDK

• Purpose: the required files to develop a .NET 8.0 or higher .NET and ASP.NET Core application with TX Text Control 34.0.
• Engine: Core, introduced in version 33.0.
• Contents: .NET assemblies for net8.0, native libraries for win-x64 and linux-x64, a Fonts folder that is copied to the build output, and the license file txtextcontrol.server.license, which is compiled into your assembly as an embedded resource.
• NuGet dependencies: none.
• Get it from: the private feed or the offline source.
• You need it: for every application that uses the Core engine, including the backends of the Document Editor and the Document Viewer.

TXTextControl.TextControl.ASP.SDK

• Purpose: the required files to develop a .NET 8.0 or higher ASP.NET application with TX Text Control 34.0.
• Engine: Classic.
• Contents: .NET assemblies for net8.0, native libraries for win-x64 and win-x86, and the license file txtextcontrol.server.license as an embedded resource.
• NuGet dependencies: System.Drawing.Common 8.0.0.
• Get it from: the private feed or the offline source.
• You need it: when your application runs on Windows only and must load or save DOC files, or when you maintain an existing Classic integration.

The engine packages target .NET 8 and higher. ASP.NET applications on the .NET Framework use the Classic engine from the Windows setup instead. See .NET Versions.

Web Packages

The web packages add the browser components to an ASP.NET Core application. They contain no document engine: install an engine package next to them.

TXTextControl.Web

• Purpose: the required files to create an ASP.NET (Core) web application with the TX Text Control Document Editor. The package contains the HTML helper that renders the editor in a Razor view (Html.TXTextControl().TextControl() in the TXTextControl.Web.MVC namespace) and the WebSocket middleware that connects the editor to the backend (app.UseTXWebSocketMiddleware()).
• Targets: net8.0 and .NET Framework 4.5.
• NuGet dependencies (net8.0): System.Drawing.Primitives 4.3.0 and the ASP.NET Core shared framework.
• Get it from: the private feed, nuget.org or the offline source.
• You need it: for the Document Editor in ASP.NET Core, including the backend of Angular, React, JavaScript and Blazor applications.

TXTextControl.Web.DocumentEditor.Backend

• Purpose: the backend components of the Document Editor and a hosted worker service that starts the backend from an ASP.NET Core application.
• How it works: the backend is a separate .NET worker process, TXTextControl.Web.Server.Core.dll. The hosted service DocumentEditorWorkerManager starts it when your application starts and stops it when the application shuts down. The worker files are included in the build output and in dotnet publish.
• Engine: Core. The backend needs the Core assemblies and native libraries in the host application, so install TXTextControl.TextControl.Core.SDK as well.
• NuGet dependencies: none apart from the ASP.NET Core shared framework.
• Get it from: the private feed.
• You need it: for every Document Editor application whose backend runs in ASP.NET Core.

TXTextControl.Web.DocumentViewer

• Purpose: the required files to create an ASP.NET (Core) web application with the TX Text Control Document Viewer, which provides document viewing, annotations and form filling. This package uses the Core version of TX Text Control.
• Engine: Core. The package does not include the TX Text Control assemblies it requires (TXTextControl.Core.dll, TXTextControl.Server.Core.dll, TXDocumentServer.Core.dll, TXBarcode.dll, TXDrawing.dll). Install TXTextControl.TextControl.Core.SDK to provide them.
• Targets: net8.0 and .NET Framework 4.5.
• NuGet dependencies (net8.0): Newtonsoft.Json 13.0.1, System.Net.Http 4.3.4 and the ASP.NET Core shared framework.
• Get it from: the private feed, nuget.org or the offline source.
• You need it: for the Document Viewer with the Core engine, in ASP.NET Core and as the backend of Angular, React, JavaScript and Blazor applications.

TXTextControl.Web.DocumentViewer.Classic

• Purpose: the Document Viewer package for the Classic version of TX Text Control.
• Engine: Classic. The package does not include the TX Text Control assemblies it requires (TXTextControl.dll, TXTextControl.Server.dll, TXDocumentServer.dll, TXBarcode.dll, TXDrawing.dll). Install TXTextControl.TextControl.ASP.SDK to provide them.
• Targets: net8.0 and .NET Framework 4.5.
• NuGet dependencies (net8.0): Newtonsoft.Json 13.0.1, System.Drawing.Common 6.0.0, System.Net.Http 4.3.4 and the ASP.NET Core shared framework.
• Get it from: the private feed or nuget.org.
• You need it: only when the Document Viewer must run with the Classic engine.

Packages on nuget.org

The Blazor components, TXTextControl.Markdown.Core, TXTextControl.PDF.Validation, TXTextControl.DocumentServer.ParallelMailMerge and the preview TXTextControl.Web.Collaboration are published on nuget.org only. Most of them build on the engine or web packages from the private feed, so you install both, as the table below shows for each scenario. Public NuGet Packages describes each package with its requirements and dependencies.

Which Packages You Need

If you evaluate the product with the trial version, install the packages from the Text Control Offline Packages source instead of the private feed, as far as that source contains them.

Frontend Packages From npm

Angular, React and Node.js applications use npm packages, for example @txtextcontrol/tx-ng-document-editor and @txtextcontrol/tx-react-document-viewer. Every Document Editor and Document Viewer frontend needs an ASP.NET Core backend with the NuGet packages listed above. See npm Packages.

Next Steps

• Text Control Private NuGet Feed — get access to the licensed packages.
• Public NuGet Packages — the packages on nuget.org in detail.
• Package Versioning — which versions belong together.
• Create Your First Application — install the Core package and create a document.