API Reference
Which properties does WPF.TextControl have, what does a method expect and since which version does a member exist? The API Reference of TX Text Control .NET for WPF 34.0 answers such questions for every namespace, class, property, method, event and enumeration: the editor element in your XAML window, the ribbon tabs and bars around it, ServerTextControl and MailMerge.
Use it alongside the guide pages of this documentation. They explain how the classes work together and link each member they name to its reference page; the reference lists all members of a class with their full details.
What the Reference Covers
Everything in the reference is .NET code that your WPF application calls from C# or Visual Basic, or sets as an attribute in XAML:
| Part | What it documents |
|---|---|
| .NET API | The namespaces of the class library: the WPF elements in TXTextControl.WPF, TXTextControl.WPF.Barcode and TXTextControl.WPF.Drawing, the document model and ServerTextControl in TXTextControl, mail merge and PDF processing in TXTextControl.DocumentServer and the namespaces below it, and the merge block dialog boxes in TXTextControl.DocumentServer.WPF |
Beside the class library, Formula Functions lists the functions that a formula in a table cell can call, such as SUM or ROUND, with their arguments and defaults.
The ribbon control itself is not part of the reference: the ribbon tabs of TX Text Control are placed in Microsoft's WPF ribbon, which the documentation of .NET describes. A JavaScript, Angular or REST reference belongs to TX Text Control .NET Server, whose Document Editor and Document Viewer run in the browser.
How a Reference Page Is Organized
Each namespace has a page that lists its classes, interfaces and enumerations. The page of a class says what the class is for and what it is derived from, such as System.Windows.Controls.Canvas, and lists its constructors, properties, methods and events. A member's page gives:
- Syntax. The declaration in C# and Visual Basic.
- Parameters and return value. The type and meaning of each parameter, and what the member returns.
- Introduced. The version of TX Text Control that added the class or member.
- Limitations and remarks. Restrictions such as "Read only", and notes on how the member behaves. Some pages add an example.
The class names in the reference are written without the root namespace: WPF.TextControl stands for TXTextControl.WPF.TextControl. A member used in an older blog article or sample may have been renamed or removed since; Breaking Changes and Deprecated APIs list those changes.
Find the Right Page
| If you want to | Read |
|---|---|
| Look up a property, method or event of the editor | WPF.TextControl in the TXTextControl.WPF namespace |
| Find the namespace of a class, or the classes of a namespace | .NET API |
| Find the classes for a task, such as tables, form fields or rulers | Classes by Task |
| Look up a ribbon tab such as the formatting tab | RibbonFormattingTab and the other tabs in TXTextControl.WPF |
Look up a member of MailMerge | MailMerge in TXTextControl.DocumentServer |
Find the values of an enumeration such as StreamType | Enumerations of the TXTextControl namespace |
| Look up the arguments of a function in a table formula | Formula Functions |
| Map a namespace in XAML or find the assembly of a class | Assemblies and XAML Namespaces |
| Learn how a class is used before looking up its members | Document Editor, Document Processing or Mail Merge and Reporting |
Where to Start
Begin with the .NET API: its table says what each namespace holds and which class to open first. When you already know the class, find it in the navigation on the left or with the search box above it.
Pages in This Section
- .NET API: the namespaces of the class library, what each holds and where to start in it.
- Classes by Task: the classes and members of each task, from character formatting to reporting, and the base classes they share.
- Formula Functions: the 85 functions of table formulas and the Excel functions of loaded worksheets.