Getting Started: Document Viewer with ASP.NET MVC (.NET Framework)

This article shows how to use the TX Text Control ASP.NET document viewer within a .NET Framework web application in Visual Studio 2022.

The source code for this example is contained in the following directories:

  • %USERPROFILE%\Documents\TX Text Control 32.0.NET Server for ASP.NET\CSharp\MVC\viewer\

Creating the Application

Make sure that you downloaded the latest version of Visual Studio 2022.

1. In Visual Studio 2022, create a new project by choosing Create a new project.

2. Select ASP.NET Web Application (.NET Framework) as the project template and confirm with Next.

3. Choose a name for your project, select .NET Framework 4.8 as the Framework and confirm with Create.

4. In the next dialog, choose MVC as the project template and confirm with Create.


Adding the NuGet Package

1. In the Solution Explorer, select your created project and choose Manage NuGet Packages... from the Project main menu.

Select either Text Control Offline Packages or as the Package source. Packages in the official Text Control NuGet profile are frequently updated.

Browse for txtextcontrol.web.documentviewer and Install the latest version of the TXTextControl.Web.DocumentViewer package.


Adding TX Text Control References

1. While the project is selected in the Solution Explorer, choose Project -> Add Project Reference... to open the Reference Manager. In the opened dialog, select Browse... to select the required TX Text Control assemblies. Navigate to the installation folder of TX Text Control and select the following assemblies from the Assembly folder:

  • TXDocumentServer.dll
  • TXTextControl.dll
  • TXTextControl.Server.dll

Repeat this step with the following assemblies from the Assembly/bin64 folder:

  • txic.dll
  • txkernel.dll
  • txtools.dll

After selecting these assemblies, close the Reference Manager by confirming with OK.

2. While the project is selected in the Solution Explorer, choose Project -> Add New Item.... Select Text File, name the file licenses.licx and close the dialog by clicking Add.


Open the newly added file and add the following content:

TXTextControl.ServerTextControl, TXTextControl.Server, Version=31.0.1600.500, Culture=neutral, PublicKeyToken=6b83fe9a75cfb638

Adding the Control to the View

1. Find the Index.cshtml file in the Views -> Home folder.Replace the complete content with the following code:

@using TXTextControl.Web.MVC.DocumentViewer
@using System.Text

<div style="width: 800px; height: 600px;">

@Html.TXTextControl().DocumentViewer(settings => {
    settings.DocumentData = Convert.ToBase64String(
        Encoding.ASCII.GetBytes("<strong>Sample Content</strong>"));
    settings.Dock = DocumentViewerSettings.DockStyle.Fill;



    var jsonAnnotations = '[[{"pen":{"type":"comment","objectWidth":32,"objectHeight":32},"user":"Unknown User","location":{"x":127,"y":50},"time":1658908087097,"comments":[{"comment":"Welcome to Text Control","user":"Unknown User","date":1658908100339,"id":"c8d818ce-ff1e-4c0c-b78c-6ba95a98dede","status":"none"}],"id":"feed80ff-1c94-4abf-9838-3e833faa4092","status":"Accepted"}]]';

    window.addEventListener("documentViewerLoaded", function () {


Compile and start the application.