Troubleshooting
Something doesn't work: a package isn't found, the Document Editor stays empty, a document has the wrong fonts or the application ends when it starts. What you see usually tells you where to look, and each page of Troubleshooting starts from such a symptom, quotes the message where TX Text Control shows one, explains the cause and gives the steps that fix it.
Find the Right Page
| If you see | Read |
|---|---|
| A TX Text Control package isn't found, doesn't install or has the wrong version | Installation |
| The private NuGet feed rejects your credentials or doesn't list a package | NuGet Authentication |
| Trial text in documents, or an exception with a license message | Licensing |
| The editor has no height, reports that it's already initialized, or your code runs too early | Document Editor |
| "Can't connect to the server." in the editor, or a lost connection | WebSockets |
| An application that works on Windows fails on a Linux server | Linux |
| A container stops, doesn't restore its packages or can't reach the backend | Docker |
| Text in another font, or moved line and page breaks | Fonts |
| Error 500.30 on IIS, or editors that lose their sessions after a while | IIS |
| An application that doesn't start or connect on Azure App Service | Azure |
A FilterException, or a converted document that looks wrong | Document Conversion |
The application fails when the engine starts, or Create returns false | Native Library / Runtime Errors |
Collect the Evidence First
Most problems are quicker to solve with the right output at hand:
- The browser console. The Document Editor logs the address it connects to and most connection errors there. See Find Out Where the Connection Fails.
- The log of your application. The messages of the Document Editor backend appear in it with the prefix
[TXTextControl.Web.Server.Core]. On IIS, turn on the log of the ASP.NET Core Module first, as Read the Log of the Application describes. - The reason of an exception. A
FilterExceptionnames its cause in itsReasonproperty and an error number in its message. See Read the Reason of a FilterException. - The replaced fonts. The
AdaptFontevent reports every font that isn't available. See Find Out Which Fonts Are Replaced. - The installed version. Which product level and service pack an application runs with shows Check Which Version Your Application Runs.
Where to Start
- A new setup doesn't work: start with Installation and Licensing, then the page of the environment you deploy to: Linux, Docker, IIS or Azure.
- The Document Editor doesn't show up: WebSockets first, because most editor problems are connection problems, then Document Editor.
- Documents look wrong: Fonts first, then Document Conversion.
If a problem started after an update, check the Breaking Changes of the versions you skipped. The Deployment Guide shows complete setups that avoid many of these problems.