API Reference
When you know what you want to do and need the exact name, signature or parameter of a class or member, the API Reference is where you look it up. It documents the .NET class library that your server code calls, the JavaScript objects that control the Document Editor and the Document Viewer in the browser and the Angular and React components that create them.
The guide pages of this documentation explain how to use these APIs and link each member they name to its page here. Use the reference to check a detail, to see all members of a class or to find out in which version a member was introduced.
What the Reference Covers
| Part | What it documents | Where the code runs |
|---|---|---|
| .NET API | The namespaces of the class library: ServerTextControl and the document model in TXTextControl, MailMerge and PDF processing in TXTextControl.DocumentServer, the HTML helpers in TXTextControl.Web.MVC, and the TXTextControl.AI packages | In your .NET application on the server |
| JavaScript API | The TXTextControl object of the Document Editor and the TXDocumentViewer object of the Document Viewer, with the objects below them | In the browser |
| Angular API | The attributes of the tx-document-editor and tx-document-viewer components | In an Angular application |
| React API | The properties of the DocumentEditor and DocumentViewer components | In a React application |
| REST API | The HTTP endpoints you meet with the product: those the components add, the one that receives signatures, your own Web API and the Web API of DS Server | Between applications |
| Formula Functions | The functions a formula in a table cell can call, with their arguments and limits | In the document |
How a Reference Page Is Organized
The .NET reference and the JavaScript reference follow the same structure. A namespace or an API lists its types; the page of a class or object describes what it is and lists its members; the page of a member gives the details:
- Declaration. The syntax of the member, in C# and Visual Basic for .NET members.
- Parameters and return value. Each parameter with its type and meaning, and what the member returns or passes to its callback.
- Introduced. The version of TX Text Control that added the member.
- Remarks and limits. Defaults, restrictions such as "Read only", and notes on how the member behaves.
The reference is the authority on names. A blog article or a sample written for an older version may call a member that has changed since; when in doubt, check the name here.
Find the Right Page
| If you want to | Read |
|---|---|
Look up a method of ServerTextControl or MailMerge | .NET API |
| Find out which namespace a class belongs to | .NET API, "Namespaces" |
| Call the Document Editor from JavaScript | JavaScript API, then the reference of the Document Editor |
| Call the Document Viewer from JavaScript | JavaScript API, then the reference of the Document Viewer |
| Set an attribute of the Angular components | Angular API |
| Set a property of the React components | React API |
| Provide documents to other applications over HTTP | REST API |
| Find the function to use in a table cell formula | Formula Functions |
| Find the classes that handle a task, or the exceptions a member throws | Classes by Task, Exceptions |
| Learn how an API is used before looking up its members | Document Processing, Document Editor or Document Viewer |
Pages in This Section
- .NET API: the namespaces of the .NET class library and what each one contains.
- JavaScript API: the browser APIs of the Document Editor and the Document Viewer.
- Angular API: the attributes, types and defaults of the Angular components.
- React API: the properties, types and defaults of the React components.
- REST API: where HTTP endpoints come from, and the Web API of DS Server.
- Formula Functions: every function of table cell formulas, with syntax, arguments and limits.