API Reference
Once you know which class does the job, the API Reference gives you the exact names, signatures and parameters to write the code. It documents every namespace, class, property, method, event and enumeration of TX Text Control .NET for Windows Forms 34.0: the TextControl on your form, the ribbon and the bars around it, ServerTextControl and MailMerge.
The guide pages of this documentation show how the classes work together and link each member they use to its page in the reference. Come here to check a detail, to see every member of a class or to find out in which version a member was introduced.
What the Reference Covers
The reference of TX Text Control .NET for Windows Forms is a .NET class library reference. The .NET API runs in your Windows Forms application and is used from C# or Visual Basic code, and the functions of table formulas are listed beside it:
| Part | What it documents |
|---|---|
| .NET API | The namespaces of the class library: the editor, the bars and the document model in TXTextControl, the ribbon in TXTextControl.Windows.Forms.Ribbon, the sidebar in TXTextControl.Windows.Forms, mail merge and PDF processing in TXTextControl.DocumentServer and the namespaces below it, and charts, barcodes and drawings |
| Formula Functions | The 85 functions of table formulas, such as SUM, ROUND and IF, with their arguments, defaults and limits, and the Excel functions of loaded worksheets |
There is no JavaScript, Angular or REST reference: the Document Editor and the Document Viewer for the browser belong to TX Text Control .NET Server.
How a Reference Page Is Organized
A namespace's page lists its classes, interfaces and enumerations. A class's page says what the class is for, what it is derived from and lists its constructors, properties, methods and events. The page of a member gives the details:
- Syntax. The declaration of the member in C# and Visual Basic.
- Parameters and return value. Each parameter with its type and meaning, 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.
Names in blog articles and older samples follow the version they were written for. When a member doesn't compile, look it up here, and check Breaking Changes and Deprecated APIs.
Find the Right Page
| If you want to | Read |
|---|---|
Look up a property, method or event of TextControl | TextControl in the TXTextControl namespace |
| Find the namespace of a class, or the classes of a namespace | .NET API |
| Find the classes and members for a task, such as tables, toolbars or mail merge | Classes by Task |
| Look up a class of the ribbon or its predefined tabs | TXTextControl.Windows.Forms.Ribbon |
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 table formula function such as ROUND or IF | Formula Functions |
| Learn how a class is used before looking up its members | Document Editor, Document Processing or Mail Merge and Reporting |
Where to Start
A reader new to the API starts with the .NET API, whose table says what each namespace holds and which class to open first. To find one class, use the navigation on the left or 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.
- Formula Functions: every function of table formulas with its arguments and defaults, and the Excel functions of loaded worksheets.