# Using TX Text Control in an ASP.NET Core Blazor Server App
> This tutorial shows how to use the Document Editor of TX Text Control .NET Server in a Blazor Server App. It uses the JSRuntime and DotNetObjectReference classes to communicate between the editor and the server-side ServerTextControl class in .NET code.
- **Author:** Bjoern Meyer
- **Published:** 2023-10-05
- **Modified:** 2025-11-16
- **Description:** This tutorial shows how to use the Document Editor of TX Text Control .NET Server in a Blazor Server App. It uses the JSRuntime and DotNetObjectReference classes to communicate between the editor and the server-side ServerTextControl class in .NET code.
- **8 min read** (1445 words)
- **Tags:**
- ASP.NET
- Blazor
- Document Editor
- **Web URL:** https://www.textcontrol.com/blog/2023/10/05/using-tx-text-control-in-a-blazor-server-app/
- **LLMs URL:** https://www.textcontrol.com/blog/2023/10/05/using-tx-text-control-in-a-blazor-server-app/llms.txt
- **LLMs-Full URL:** https://www.textcontrol.com/blog/2023/10/05/using-tx-text-control-in-a-blazor-server-app/llms-full.txt
- **GitHub Repository:** https://github.com/TextControl/TXTextControl.Server.Blazor
---
> **Using .NET 8?**
>
> This tutorial shows how to create a Blazor Server App with .NET 6. Follow the steps in the following tutorial if you are using .NET 8.
>
> [Using TX Text Control in a Blazor Server App with .NET 8 ](https://www.textcontrol.com/blog/2024/01/25/using-tx-text-control-in-an-blazor-server-app-with-net-8/llms-full.txt)
ASP.NET Blazor enables .NET developers to use C# to build rich web applications with less JavaScript. In reality, many applications use JavaScript to communicate between the local JavaScript layer and C# objects because JavaScript has direct access to the HTML DOM.
By creating a Razor component using Interop JavaScript, the TX Text Control Document Editor can be integrated and initialized in Blazor. This sample uses the [JSRuntime](https://learn.microsoft.com/en-us/dotnet/api/microsoft.jsinterop.jsruntime?view=aspnetcore-7.0) and [DotNetObjectReference](https://learn.microsoft.com/en-us/dotnet/api/microsoft.jsinterop.dotnetobjectreference?view=aspnetcore-7.0) classes to communicate between the editor and the server-side ServerTextControl class in .NET code.
#### Data Flow
The diagram below is an illustration of the data flow in this concept. The Text Control Razor component dynamically adds the TX Text Control Document Editor to the page by initializing it with JavaScript. The JSRuntime is used to create an object reference to the created JavaScript file. This object reference calls the JavaScript API of the TX Text Control.
### Creating the Application
Make sure that you downloaded the latest version of Visual Studio 2022 that comes with the [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0).
1. In Visual Studio 2022, create a new project by choosing *Create a new project*.
2. Select *Blazor Server App* as the project template and confirm with *Next*.
3. Choose a name for your project and confirm with *Next*.
4. In the next dialog, choose *.NET 6 (Long-term support)* as the *Framework* and confirm with *Create*.
#### Adding the NuGet Package
5. In the *Solution Explorer*, select your created project and choose *Manage NuGet Packages...* from the *Project* main menu.
> **Package Source**
>
> Select either **Text Control Offline Packages** or **nuget.org** as the *Package source*. Packages in the official *Text Control* NuGet profile are frequently updated.
Browse and install the following packages:
- *TXTextControl.Web*
- *TXTextControl.TextControl.ASP.SDK*
#### Configure the Application
6. Open the *Program.cs* file located in the project's root folder.
At the very top of the file, insert the following code:
```
using TXTextControl.Web;
```
Add the following code after the entry `app.UseStaticFiles();`:
```
// enable Web Sockets
app.UseWebSockets();
// attach the Text Control WebSocketHandler middleware
app.UseTXWebSocketMiddleware();
```
#### Creating the Interop JavaScript
7. Create a new folder *scripts* in your *wwwroot* folder, create a new JavaScript file and name it *textcontrol.js*. Paste the following content into the file you have just created.
```
var dotNetObject;
export async function addEditorToElement(dotNetRef, options) {
dotNetObject = dotNetRef;
TXTextControl.init({
containerID: "txDocumentEditorContainer",
webSocketURL: options.websocketurl
});
}
export function saveDocument() {
// save the document on TXTextControl object
TXTextControl.saveDocument(TXTextControl.StreamType.InternalUnicodeFormat, function (document) {
// call the .NET method 'ProcessDocument' with the saved document data
dotNetObject.invokeMethodAsync('ProcessDocument', document.data);
});
};
export function loadDocument(document) {
// load the document back into the editor (TXTextControl)
TXTextControl.loadDocument(TXTextControl.StreamType.InternalUnicodeFormat, document);
};
export function insertTable() {
TXTextControl.tables.add(5, 5, 10, function (e) {
if (e === true) { // if added
TXTextControl.tables.getItem(function (table) {
table.cells.forEach(function (cell) {
cell.setText("Cell text");
});
}, null, 10);
}
})
};
```
#### Creating the Razor Component
This step creates a new Razor component named *TextControl.razor* that initializes both the .NET object reference and the JavaScript object reference.
8. Select the project in the *Solution Explorer* and choose *New Item...* from the *Project* main menu. Select *Razor Component*, name it *TextControl.razor* and confirm with *Add*.
9. Paste the following code into the newly created file:
```
@inject IJSRuntime JsRuntime
@inject NavigationManager Navigator
@code
{
[Parameter]
public string? WebSocketURL { get; set; }
[Parameter]
public string? ContainerID { get; set; }
[Parameter]
public string? Width { get; set; } = "800px";
[Parameter]
public string? Height { get; set; } = "600px";
private DotNetObjectReference DotNetReference => DotNetObjectReference.Create(this);
private IJSObjectReference? _txtextcontrol;
protected override async Task OnAfterRenderAsync(bool firstRender)
{
if (firstRender)
{
_txtextcontrol = await JsRuntime.InvokeAsync("import", "./scripts/textcontrol.js");
var options = new Dictionary();
var webSocketURL = Navigator.BaseUri.Replace("https://", "wss://").Replace("http://", "ws://");
if (WebSocketURL != null)
{
options["websocketurl"] = $"{webSocketURL}api/TXWebSocket";
options["baseurl"] = $"{WebSocketURL}api/TXWebSocket";
}
if (ContainerID != null)
{
options["containerid"] = ContainerID;
}
await _txtextcontrol.InvokeVoidAsync("addEditorToElement", DotNetReference, options);
}
}
public async Task SaveDocument()
{
await _txtextcontrol.InvokeVoidAsync("saveDocument", DotNetReference);
}
[JSInvokable("ProcessDocument")]
public void ProcessDocument(string document)
{
byte[] bDocument;
// create a ServerTextControl instance to load the saved document
using (TXTextControl.ServerTextControl tx = new TXTextControl.ServerTextControl())
{
tx.Create();
tx.Load(Convert.FromBase64String(document), TXTextControl.BinaryStreamType.InternalUnicodeFormat);
// add additional text to the document
tx.Selection.Text = "This document has been modified by .NET\r\n";
// save back
tx.Save(out bDocument, TXTextControl.BinaryStreamType.InternalUnicodeFormat);
}
// invoke the JS function 'loadDocument' to load back to the modified document
_txtextcontrol.InvokeVoidAsync("loadDocument", Convert.ToBase64String(bDocument));
}
public async Task InsertTable()
{
await _txtextcontrol.InvokeVoidAsync("insertTable");
}
}
```
Any function of the referenced *textcontrol.js* JavaScript file can be called using the created *IJSObjectReference* *\_txtextcontrol*. The *DotNetObjectReference* points to this Razor component. This is passed to the JavaScript functions to save and reload the document.
#### Consuming the TextControl Razor Component
In this step, we are going to use the Razor component we have created on a page.
10. Find the *Index.razor* page in the *Pages* folder and replace the content with the following code:
```
@page "/"
@inject NavigationManager Navigator;
@code
{
private TextControl _txtextcontrol = default!;
// insert a table using the client-side API
private async Task InsertTable()
{
await _txtextcontrol.InsertTable();
}
// save the document and reload it using ServerTextControl
private async Task SaveDocument()
{
await _txtextcontrol.SaveDocument();
}
}
```
Compile and start the application.
#### First Button: Insert Table
The *InsertTable()* method is called in the .NET code of *Index.razor* when the first button is clicked.
```
private async Task InsertTable()
{
await _txtextcontrol.InsertTable();
}
```
This calls the *InsertTable()* method of the *TextControl.Razor* component.
```
public async Task InsertTable()
{
await _txtextcontrol.InvokeVoidAsync("insertTable");
}
```
In this method, the JavaScript object reference *\_txtextcontrol* is used to invoke a JavaScript call to *textcontrol.js*.
```
export function insertTable() {
TXTextControl.tables.add(5, 5, 10, function (e) {
if (e === true) { // if added
TXTextControl.tables.getItem(function (table) {
table.cells.forEach(function (cell) {
cell.setText("Cell text");
});
}, null, 10);
}
})
};
```
#### Second Button: Save and Reload
TX Text Control's JavaScript API is used to store the document. The document is passed to .NET (the "server"). In .NET, the document is processed using an instance of ServerTextControl and sent back to the client side by calling a JavaScript function that loads the content back into the TX Text Control document editor.
The *SaveDocument()* method is called in the .NET code of *Index.razor* when the second button is clicked.
```
private async Task SaveDocument()
{
await _txtextcontrol.SaveDocument();
}
```
This calls the *SaveDocument()* method of the *TextControl.Razor* component.
```
export function saveDocument() {
// save the document on TXTextControl object
TXTextControl.saveDocument(TXTextControl.StreamType.InternalUnicodeFormat, function (document) {
// call the .NET method 'ProcessDocument' with the saved document data
dotNetObject.invokeMethodAsync('ProcessDocument', document.data);
});
};
```
This calls the JavaScript function *saveDocument()* in the *textcontrol.js* JavaScript file:
After the document is saved, it is passed to the .NET *ProcessDocument* method implemented in *TextControl.razor* using the created .NET object reference.
```
[JSInvokable("ProcessDocument")]
public void ProcessDocument(string document)
{
byte[] bDocument;
// create a ServerTextControl instance to load the saved document
using (TXTextControl.ServerTextControl tx = new TXTextControl.ServerTextControl())
{
tx.Create();
tx.Load(Convert.FromBase64String(document), TXTextControl.BinaryStreamType.InternalUnicodeFormat);
// add additional text to the document
tx.Selection.Text = "This document has been modified by .NET\r\n";
// save back
tx.Save(out bDocument, TXTextControl.BinaryStreamType.InternalUnicodeFormat);
}
// invoke the JS function 'loadDocument' to load back to the modified document
_txtextcontrol.InvokeVoidAsync("loadDocument", Convert.ToBase64String(bDocument));
}
```
This method is parametrized as *JSInvokable* and can be called from JavaScript.
This method loads the document into a ServerTextControl instance to add text at the top. The document is then saved and passed to the *loadDocument* JavaScript function.
The JavaScript function *loadDocument* is finally loading the document back into the editor.
```
export function loadDocument(document) {
// load the document back into the editor (TXTextControl)
TXTextControl.loadDocument(TXTextControl.StreamType.InternalUnicodeFormat, document);
};
```
For your own testing, you can download and try this sample from our GitHub repository.
---
## About Bjoern Meyer
As CEO, Bjoern is the visionary behind our strategic direction and business development, bridging the gap between our customers and engineering teams. His deep passion for coding and web technologies drives the creation of innovative products. If you're at a tech conference, be sure to stop by our booth - you'll most likely meet Bjoern in person. With an advanced graduate degree (Dipl. Inf.) in Computer Science, specializing in AI, from the University of Bremen, Bjoern brings significant expertise to his role. In his spare time, Bjoern enjoys running, paragliding, mountain biking, and playing the piano.
- [LinkedIn](https://www.linkedin.com/in/bjoernmeyer/)
- [X](https://x.com/txbjoern)
- [GitHub](https://github.com/bjoerntx)
---
## Related Posts
- [Building an ASP.NET Core Backend (Linux and Windows) for the Document Editor and Viewer](https://www.textcontrol.com/blog/2025/03/26/building-an-asp-net-core-backend-for-the-document-editor-and-viewer/llms.txt)
- [TX Text Control for Blazor: Mail Merge Integration Tutorial](https://www.textcontrol.com/blog/2025/03/25/tx-text-control-for-blazor-mail-merge-integration-tutorial/llms.txt)
- [TX Text Control Document Editor and Viewer for Blazor Released](https://www.textcontrol.com/blog/2025/03/25/tx-text-control-document-editor-and-viewer-for-blazor-released/llms.txt)
- [Getting Started: Document Editor for Blazor in ASP.NET Core](https://www.textcontrol.com/blog/2025/03/25/getting-started-document-editor-for-blazor-in-asp-net-core/llms.txt)
- [Announcing Our Work on a Blazor Component for Document Editing and Viewing](https://www.textcontrol.com/blog/2025/01/24/announcing-our-work-on-a-blazor-component-for-document-editing-and-viewing/llms.txt)
- [Using TX Text Control in a Blazor Server App with .NET 8](https://www.textcontrol.com/blog/2024/01/25/using-tx-text-control-in-an-blazor-server-app-with-net-8/llms.txt)
- [Beyond WebSockets: A Glimpse into the Future of Document Editing with WebAssembly](https://www.textcontrol.com/blog/2026/06/10/beyond-websockets-glimpse-future-document-editing-webassembly/llms.txt)
- [5 Layout Patterns for Integrating the TX Text Control Document Editor in ASP.NET Core C#](https://www.textcontrol.com/blog/2026/04/09/5-layout-patterns-for-integrating-the-tx-text-control-document-editor-in-aspnet-core-csharp/llms.txt)
- [Introducing Text Control Agent Skills](https://www.textcontrol.com/blog/2026/03/27/introducing-text-control-agent-skills/llms.txt)
- [Deploying the TX Text Control Document Editor from the Private NuGet Feed to Azure App Services (Linux and Windows)](https://www.textcontrol.com/blog/2026/03/25/deploying-the-tx-text-control-document-editor-from-the-private-nuget-feed-to-azure-app-services-linux-and-windows/llms.txt)
- [Build a Custom Backstage View in ASP.NET Core with TX Text Control](https://www.textcontrol.com/blog/2026/02/17/build-a-custom-backstage-view-in-aspnet-core-with-tx-text-control/llms.txt)
- [ASP.NET Core Document Editor with Backend via the Text Control Private NuGet Feed](https://www.textcontrol.com/blog/2026/02/09/aspnet-core-document-editor-private-nuget-feed/llms.txt)
- [Why Document Processing Libraries Require a Document Editor](https://www.textcontrol.com/blog/2025/12/04/why-document-processing-libraries-require-a-document-editor/llms.txt)
- [Getting Started Video Tutorial: Document Editor in ASP.NET Core C# on Linux](https://www.textcontrol.com/blog/2025/07/29/getting-started-video-tutorial-document-editor-aspnet-core-csharp-linux/llms.txt)
- [Document Protection in ASP.NET with TX Text Control: Healthcare Use Cases](https://www.textcontrol.com/blog/2025/06/25/document-protection-in-asp-dotnet-with-tx-text-control-healthcare-use-cases/llms.txt)
- [E-Sign Comes to Blazor: Document Viewer 33.0.1 Released](https://www.textcontrol.com/blog/2025/04/24/e-sign-comes-to-blazor-document-viewer-33-0-1-released/llms.txt)
- [Deploying the TX Text Control Document Editor in an ASP.NET Core Web App to Azure App Services](https://www.textcontrol.com/blog/2025/03/26/deploying-the-tx-text-control-document-editor-in-an-asp-net-core-web-app-to-azure-app-services/llms.txt)
- [Getting Started: Document Viewer for Blazor in ASP.NET Core](https://www.textcontrol.com/blog/2025/03/25/getting-started-document-viewer-for-blazor-in-asp-net-core/llms.txt)
- [Introducing TXTextControl.Web.Server.Core: A Cross-Platform Backend for TX Text Control Document Editor](https://www.textcontrol.com/blog/2025/03/13/introducing-txtextcontrol-web-server-core-a-cross-platform-backend-for-tx-text-control-document-editor/llms.txt)
- [Getting Started: Document Editor with ASP.NET Core and Docker Support with Linux Containers](https://www.textcontrol.com/blog/2025/03/12/getting-started-document-editor-with-asp-net-core-and-docker-support-with-linux-containers/llms.txt)
- [Preparing Documents for E-Signing for Multiple Signers in .NET C#](https://www.textcontrol.com/blog/2024/11/13/preparing-documents-for-e-signing-for-multiple-signers-in-net-c-sharp/llms.txt)
- [ASP.NET Core: Use the Document Editor and Viewer in the Same Razor View](https://www.textcontrol.com/blog/2024/11/08/asp-net-core-use-the-document-editor-and-viewer-in-the-same-razor-view/llms.txt)
- [Connecting the TXWebSocketMiddleware to a Separate, External TCP Synchronization Service](https://www.textcontrol.com/blog/2024/10/01/connecting-the-txwebsocketmiddleware-to-a-separate-external-tcp-synchronization-service/llms.txt)
- [Getting Started: Creating an ASP.NET Core Web App with the Document Editor in Visual Studio Code (VS Code)](https://www.textcontrol.com/blog/2024/09/27/getting-started-creating-an-asp-net-core-web-app-with-the-document-editor-in-visual-studio-code-vs-code/llms.txt)
- [Getting Started Video Tutorial: How to use the Document Editor in ASP.NET Core C#](https://www.textcontrol.com/blog/2024/08/05/getting-started-video-tutorial-how-to-use-the-document-editor-in-asp-net-core-csharp/llms.txt)