.NET API
Every class, property, method and event that your C# code calls is documented in the .NET class library reference, sorted by namespace. Which namespace a class lives in tells you a lot about what it is for: the document engine and its document model are in TXTextControl, mail merge and PDF processing in TXTextControl.DocumentServer and the namespaces below it, and the ASP.NET Core integration of the Document Editor and the Document Viewer in TXTextControl.Web.MVC.
The table of namespaces below says what each one contains and where to start in it. A namespace's page in the reference lists its classes, interfaces and enumerations, and a class's page lists its members.
Namespaces
| Namespace | What it contains | Start with |
|---|---|---|
| TXTextControl | The document engine for server code and the document model it works with: text, selection, paragraphs, tables, images, fields, sections, headers and footers, and the settings for loading and saving | ServerTextControl, LoadSettings, SaveSettings |
| TXTextControl.DocumentServer | Mail merge: the class that merges templates with data, and the arguments of its events | MailMerge |
| TXTextControl.DocumentServer.DataSources | Information about the tables, columns and relations of a data source, and the settings of a merge and its merge blocks | DataSourceManager, MergeSettings |
| TXTextControl.DocumentServer.DataShaping | Instructions that filter and sort the data of merge blocks before the merge | FilterInstruction, SortingInstruction |
| TXTextControl.DocumentServer.Fields | Field adapters that give typed access to merge fields, IF fields, legacy form fields and content controls | MergeField, IfField, FormText |
| TXTextControl.DocumentServer.Json | The exceptions that MergeJsonData throws for JSON it can't parse | ParserException |
| TXTextControl.DocumentServer.PDF | Methods for PDF documents: form fields and embedded files | Forms, Attachments |
| TXTextControl.DocumentServer.PDF.AcroForms | The AcroForm fields read from a PDF document: text fields, check boxes, radio buttons, list and combo boxes, buttons | FormField |
| TXTextControl.DocumentServer.PDF.Contents | Lines of text found in a PDF document, with their page and position | Lines |
| TXTextControl.DataVisualization | Charts, barcodes and drawings placed in a document, with their layout and position | ChartFrame, BarcodeFrame |
| TXTextControl.Barcode | The type and format of a barcode, rendered as SVG | TXBarcodeCore |
| TXTextControl.Drawing | The type and format of shapes in a drawing, rendered as SVG | TXDrawingCore |
| TXTextControl.ServerVisualization | Generators that render the text, the rulers, the status bar and the dialog boxes of a document as images, and pass user input to it | TextViewGenerator |
| TXTextControl.Web.MVC | The HTML helper that renders the Document Editor in an ASP.NET Core view, and its settings; package TXTextControl.Web | TextControlSettings, HtmlHelperExtension |
| TXTextControl.Web.MVC.DocumentViewer | The HTML helper that renders the Document Viewer, and its settings for loading documents, PDF.js and signatures; package TXTextControl.Web.DocumentViewer | DocumentViewerSettings |
| TXTextControl.Web.MVC.DocumentViewer.Models | The data the Document Viewer sends after a signature: the signed document, the signature boxes and the completed form fields | SignatureData |
| TXTextControl.Web | An editor control for ASP.NET Web Forms on the .NET Framework, derived from System.Web.UI.WebControls.WebControl, its text parts and enumerations | TextControl |
| TXTextControl.DocumentServer.Web | A document viewer control for ASP.NET Web Forms, derived from System.Web.UI.WebControls.CompositeControl | DocumentViewer |
The Windows Forms and WPF controls, TextControl and WPF.TextControl, belong to the desktop products and don't exist in TX Text Control .NET Server. Code in an ASP.NET Core application, a service or a console application works with ServerTextControl.
Find the Right Namespace
| If you want to | Start in |
|---|---|
| Create, load, change, convert or save a document | TXTextControl, with ServerTextControl |
| Merge a template with JSON data, objects or ADO.NET data | TXTextControl.DocumentServer, with MailMerge |
| Read the merge fields or form fields of a template | TXTextControl.DocumentServer.Fields |
| Read AcroForm fields, embedded files or lines of text from a PDF | TXTextControl.DocumentServer.PDF and the namespaces below it |
| Configure the Document Editor or the Document Viewer in an ASP.NET Core view | TXTextControl.Web.MVC or TXTextControl.Web.MVC.DocumentViewer |
| Receive a document signed in the Document Viewer | TXTextControl.Web.MVC.DocumentViewer.Models |
The pages of Document Processing, Mail Merge and Reporting and PDF Processing show these classes at work and link each member they use to its reference page.
To find classes by what they do rather than by namespace, Classes by Task lists the classes and members for each task, such as tables, form fields, styles, mail merge or PDF forms, together with the base classes they share. Exceptions describes what the class library throws and when.
TX Text Control AI Packages
Beside the namespaces, the navigation lists the TXTextControl.AI packages: TXTextControl.AI with TXTextControl.AI.AspNetCore, TXTextControl.AI.Knowledge, TXTextControl.AI.LlamaServer, TXTextControl.AI.Mcp and TXTextControl.AI.McpServer. They are prerelease packages on nuget.org, and each is documented by the README it ships with. Text Control AI explains what each package does and how they work together.
Pages in This Section
- TXTextControl:
ServerTextControland the document model. - TXTextControl.DocumentServer:
MailMergeand its events. - TXTextControl.Web: the Web Forms editor control and its enumerations.
- Classes by Task: the classes and members for each task, and the base classes they share.
- Exceptions: the exceptions of the class library and what throws them.