.NET API
TX Text Control .NET for WPF splits its classes between namespaces for WPF and namespaces it shares with the other TX Text Control products. Everything that is a WPF element, from WPF.TextControl to the ribbon tabs and the barcode and drawing controls, has WPF in its namespace; the document model, ServerTextControl and MailMerge are in TXTextControl and TXTextControl.DocumentServer, the same as in TX Text Control .NET for Windows Forms and TX Text Control .NET Server.
Every namespace of the class library reference is listed below, with what it holds and the classes to open first. A namespace's page lists its classes, interfaces and enumerations, and a class's page lists its members.
Namespaces
| Namespace | What it holds | Start with |
|---|---|---|
| TXTextControl.WPF | The editor element and its document canvas, the twelve ribbon tabs, the button bar, ruler bar, status bar and sidebar, the mini toolbars, dialog boxes such as the bookmark and hyperlink dialogs, the resource provider and value converters for XAML bindings | TextControl, RibbonFormattingTab, Sidebar |
| TXTextControl | The engine without a user interface and the document model: text, selection, paragraphs, tables, images, fields, form fields, sections, headers and footers and the settings for loading and saving | ServerTextControl, Selection, LoadSettings |
| 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 | FilterInstruction, SortingInstruction |
| TXTextControl.DocumentServer.Fields | Field adapters for typed access to merge fields, IF fields, legacy form fields and content controls | MergeField, IfField, FormText |
| TXTextControl.DocumentServer.Json | The exceptions thrown for JSON data that can't be parsed | ParserException |
| TXTextControl.DocumentServer.PDF | Methods that read the form fields and embedded files of a PDF document | Forms, Attachments |
| TXTextControl.DocumentServer.PDF.AcroForms | The AcroForm fields read from a PDF document: text fields, check boxes, radio buttons, list and combo boxes and buttons | FormField |
| TXTextControl.DocumentServer.PDF.Contents | The lines of text found in a PDF document, with their page and position | Lines |
| TXTextControl.DocumentServer.WPF | The WPF dialog boxes for merge blocks: insert and edit merge blocks, filter and sort their data and edit data relations | InsertMergeBlockDialog, FilterAndSortDialog |
| TXTextControl.DataVisualization | The frames that position a chart, a barcode or a drawing in a document, their collections and events | ChartFrame, BarcodeFrame, DrawingFrame |
| TXTextControl.Barcode | The type and format of a barcode, rendered as SVG | TXBarcodeCore |
| TXTextControl.WPF.Barcode | The WPF element that shows a barcode | TXBarcodeControl |
| TXTextControl.Drawing | The shapes of a drawing with their fill and outline, rendered as SVG | TXDrawingCore |
| TXTextControl.WPF.Drawing | The WPF element that shows a drawing, and its context menu | TXDrawingControl |
The navigation on the left links six of these namespaces directly; open the other ten from the table above.
One class is filed outside its namespace: the reference lists the mini toolbar WPF.MiniToolbar with the TXTextControl namespace, but in code it is TXTextControl.WPF.MiniToolbar.
Find the Right Namespace
| If you want to | Start in |
|---|---|
| Control the editor in a window: load, save, format, print | TXTextControl.WPF, with WPF.TextControl |
| Work with the text, tables and fields of the document | TXTextControl, with Selection and the collections of the editor |
| Create or convert a document without a visible editor | TXTextControl, with ServerTextControl |
| Add ribbon tabs, toolbars, rulers or the sidebar to a window | TXTextControl.WPF |
| Merge a template with JSON data, objects or a database | TXTextControl.DocumentServer, with MailMerge |
| Open a merge block dialog box from your own button | TXTextControl.DocumentServer.WPF |
| Read AcroForm fields, embedded files or text lines from a PDF | TXTextControl.DocumentServer.PDF and the namespaces below it |
When you know the task but not the namespace, Classes by Task lists the classes and members of each task, such as tables, form fields, rulers or merge blocks, with the topic page that uses them.
Assemblies and XAML Namespaces shows which assembly holds each namespace and how a window maps TXTextControl.WPF in XAML. The pages of Document Editor, Document Processing, Mail Merge and Reporting and PDF Processing show the classes at work.
Where to Start
- Open WPF.TextControl: its properties and methods are the entry point for most tasks in the editor.
- Continue to Selection in
TXTextControl, where the document model begins. - Look up the namespace of the feature you work on in the table above, or its classes in Classes by Task.